@@ -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,46 +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------------------------------------------------------------------------------
3741import Control.Applicative
38−import Data.Monoid ((<>))
39−import qualified Data.Set as Set
40−import qualified Data.Text.Encoding as E
41−import Data.CaseInsensitive (mk)
42+import qualified Data.CaseInsensitive as CI
4243import Data.Functor.Identity
43−import Data.Proxy (Proxy (..))
4444import qualified Data.Map as Map
45+import Data.Monoid ((<>))
46+import Data.Proxy (Proxy (..))
47+import qualified Data.Set as Set
4548import Data.Text (Text)
4649import qualified Data.Text as T
50+import qualified Data.Text.Encoding as E
51+import GHC.Exts (Constraint)
4752import GHC.TypeLits (KnownSymbol, symbolVal)
48−import Servant.API ((:<|>)(..),(:>), BasicAuth,
49− BasicAuthData, BuildHeadersTo(..),
50− Capture, contentType, Header,
51− Headers(..), HttpVersion, IsSecure,
52− MimeRender(..), MimeUnrender,
53− NoContent, QueryFlag, QueryParam,
54− QueryParams, Raw, ReflectMethod(..),
53+import Servant.API ((:<|>) (..), (:>), BasicAuth,
54+ BasicAuthData, BuildHeadersTo (..),
55+ Capture, Header, Headers (..),
56+ HttpVersion, IsSecure,
57+ MimeRender (..), MimeUnrender,
58+ NoContent, QueryFlag, QueryParam',
59+ QueryParams, Raw, ReflectMethod (..),
5560 RemoteHost, ReqBody,
56− ToHttpApiData(..), Vault, Verb)
57−
58−import Reflex.Dom (Dynamic, Event, Reflex,
59− XhrRequest(..),
60− XhrResponseHeaders(..),
61− XhrResponse(..), attachPromptlyDynWith, constDyn, ffor, fmapMaybe,
62− leftmost, performRequestsAsync,
63− )
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)
6472------------------------------------------------------------------------------
6573import Servant.Common.BaseUrl (BaseUrl(..), Scheme(..), baseUrlWidget,
6674 showBaseUrl,
6775 SupportsServantReflex)
68−import Servant.Common.Req (Req, ReqResult(..), QParam(..),
76+import Servant.Common.Req (ClientOptions(..),
77+ defaultClientOptions,
78+ Req, ReqResult(..), QParam(..),
6979 QueryPart(..), addHeader, authData,
7080 defReq, evalResponse, prependToPathParts,
7181 -- performRequestCT,
@@ -75,9 +85,10 @@ import Servant.Common.Req (Req, ReqResult(..), QParam(..),
7585 performSomeRequestsAsync,
7686 qParamToQueryPart, reqBody,
7787 reqSuccess, reqFailure,
78− reqMethod, respHeaders, response,
88+ reqMethod, respHeaders,
89+ response,
7990 reqTag,
80− qParams)
91+ qParams, withCredentials)
8192
8293
8394-- * Accessing APIs as a Client
@@ -92,28 +103,75 @@ import Servant.Common.Req (Req, ReqResult(..), QParam(..),
92103-- >
93104-- > getAllBooks :: Event t l -> m (Event t (l, ReqResult [Book]))
94105-- > postNewBook :: Dynamic t (Maybe Book) -> Event t l
95−-- -> m (Event t (l, ReqResult Book)))
106+-- > -> m (Event t (l, ReqResult Book)))
96107-- > (getAllBooks :<|> postNewBook) = client myApi host
97108-- > where host = constDyn $ BaseUrl Http "localhost" 8080
98−client :: (HasClient t m layout tag)
99− => Proxy layout -> Proxy m -> Proxy tag -> Dynamic t BaseUrl -> Client t m layout tag
100−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
101141
102142
103143-- | This class lets us define how each API combinator
104144-- influences the creation of an HTTP request. It's mostly
105145-- an internal class, you can just use 'client'.
106−class HasClient t m layout (tag :: *) where
146+class Monad m => HasClient t m layout (tag :: *) where
107147 type Client t m layout tag :: *
108− 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
109167
110168
111169instance (HasClient t m a tag, HasClient t m b tag) => HasClient t m (a :<|> b) tag where
112170 type Client t m (a :<|> b) tag = Client t m a tag :<|> Client t m b tag
113171
114− clientWithRoute Proxy q pTag req baseurl =
115− clientWithRoute (Proxy :: Proxy a) q pTag req baseurl :<|>
116− 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
117175
118176
119177-- Capture. Example:
@@ -134,11 +192,9 @@ instance (SupportsServantReflex t m, ToHttpApiData a, HasClient t m sublayout ta
134192 type Client t m (Capture capture a :> sublayout) tag =
135193 Dynamic t (Either Text a) -> Client t m sublayout tag
136194
137− clientWithRoute Proxy q t req baseurl val =
138− clientWithRoute (Proxy :: Proxy sublayout)
139− q t
140− (prependToPathParts p req)
141− 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
142198 where p = (fmap . fmap) (toUrlPiece) val
143199
144200
@@ -151,9 +207,8 @@ instance {-# OVERLAPPABLE #-}
151207 Event t tag -> m (Event t (ReqResult tag a))
152208 -- TODO how to access input types here?
153209 -- ExceptT ServantError IO a
154− clientWithRoute Proxy _ _ req baseurl trigs =
155− -- performRequestCT (Proxy :: Proxy ct) method req' baseurl trigs
156− 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
157212 where method = E.decodeUtf8 $ reflectMethod (Proxy :: Proxy method)
158213 req' = req { reqMethod = method }
159214
@@ -166,29 +221,33 @@ instance {-# OVERLAPPING #-}
166221 Event t tag -> m (Event t (ReqResult tag NoContent))
167222 -- TODO: how to access input types here?
168223 -- ExceptT ServantError IO NoContent
169− clientWithRoute Proxy _ _ req baseurl =
170− (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
171226 where method = E.decodeUtf8 $ reflectMethod (Proxy :: Proxy method)
172227
173228
174229toHeaders :: BuildHeadersTo ls => ReqResult tag a -> ReqResult tag (Headers ls a)
175230toHeaders r =
176− let toBS = E.encodeUtf8
177− hdrs = maybe []
178− (\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))
179233 (Map.toList $ _xhrResponse_headers xhr))
180234 (response r)
181235 in ffor r $ \a -> Headers {getResponse = a ,getHeadersHList = buildHeadersTo hdrs}
182236
237+
183238class BuildHeaderKeysTo hs where
184− buildHeaderKeysTo :: Proxy hs -> [T.Text]
239+ buildHeaderKeysTo :: Proxy hs -> [CI.CI T.Text]
185240
186241instance {-# OVERLAPPABLE #-} BuildHeaderKeysTo '[]
187242 where buildHeaderKeysTo _ = []
188243
189244instance {-# OVERLAPPABLE #-} (BuildHeaderKeysTo xs, KnownSymbol h)
190245 => BuildHeaderKeysTo ((Header h v) ': xs) where
191− 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+
192251
193252-- HEADERS Verb (Content) --
194253-- Headers combinator not treated in fully general case,
@@ -203,10 +262,10 @@ instance {-# OVERLAPPABLE #-}
203262 ) => HasClient t m (Verb method status cts' (Headers ls a)) tag where
204263 type Client t m (Verb method status cts' (Headers ls a)) tag =
205264 Event t tag -> m (Event t (ReqResult tag (Headers ls a)))
206− clientWithRoute Proxy _ _ req baseurl trigs = do
265+ clientWithRouteAndResultHandler Proxy _ _ req baseurl opts wrap trigs = do
207266 let method = E.decodeUtf8 $ reflectMethod (Proxy :: Proxy method)
208− resp <- fmap runIdentity <$> performRequestsCT (Proxy :: Proxy ct) method (constDyn $ Identity req') baseurl trigs
209− return $ toHeaders <$> resp
267+ resp <- fmap runIdentity <$> performRequestsCT (Proxy :: Proxy ct) method (constDyn $ Identity req') baseurl opts trigs
268+ wrap $ toHeaders <$> resp
210269 where req' = req { respHeaders =
211270 OnlyHeaders (Set.fromList (buildHeaderKeysTo (Proxy :: Proxy ls)))
212271 }
@@ -219,10 +278,10 @@ instance {-# OVERLAPPABLE #-}
219278 ) => HasClient t m (Verb method status cts (Headers ls NoContent)) tag where
220279 type Client t m (Verb method status cts (Headers ls NoContent)) tag
221280 = Event t tag -> m (Event t (ReqResult tag (Headers ls NoContent)))
222− clientWithRoute Proxy _ _ req baseurl trigs = do
281+ clientWithRouteAndResultHandler Proxy _ _ req baseurl opts wrap trigs = do
223282 let method = E.decodeUtf8 $ reflectMethod (Proxy :: Proxy method)
224− resp <- fmap runIdentity <$> performRequestsNoBody method (constDyn $ Identity req') baseurl trigs
225− return $ toHeaders <$> resp
283+ resp <- fmap runIdentity <$> performRequestsNoBody method (constDyn $ Identity req') baseurl opts trigs
284+ wrap $ toHeaders <$> resp
226285 where req' = req {respHeaders =
227286 OnlyHeaders (Set.fromList (buildHeaderKeysTo (Proxy :: Proxy ls)))
228287 }
@@ -249,11 +308,11 @@ instance (KnownSymbol sym, ToHttpApiData a,
249308 type Client t m (Header sym a :> sublayout) tag =
250309 Dynamic t (Either Text a) -> Client t m sublayout tag
251310
252− clientWithRoute Proxy q t req baseurl eVal =
253− clientWithRoute (Proxy :: Proxy sublayout)
254− q t
255− (Servant.Common.Req.addHeader hname eVal req)
256− 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
257316 where hname = T.pack $ symbolVal (Proxy :: Proxy sym)
258317
259318
@@ -267,8 +326,21 @@ instance HasClient t m sublayout tag
267326 type Client t m (HttpVersion :> sublayout) tag =
268327 Client t m sublayout tag
269328
270− clientWithRoute Proxy q t =
271− 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+
272344
273345
274346-- | If you use a 'QueryParam' in one of your endpoints in your API,
@@ -298,15 +370,15 @@ instance HasClient t m sublayout tag
298370-- > -- 'getBooksBy Nothing' for all books
299371-- > -- 'getBooksBy (Just "Isaac Asimov")' to get all books by Isaac Asimov
300372instance (KnownSymbol sym, ToHttpApiData a, HasClient t m sublayout tag, Reflex t)
301− => HasClient t m (QueryParam sym a :> sublayout) tag where
373+ => HasClient t m (QueryParam' mods sym a :> sublayout) tag where
302374
303− type Client t m (QueryParam sym a :> sublayout) tag =
375+ type Client t m (QueryParam' mods sym a :> sublayout) tag =
304376 Dynamic t (QParam a) -> Client t m sublayout tag
305377
306378 -- if mparam = Nothing, we don't add it to the query string
307− clientWithRoute Proxy q t req baseurl mparam =
308− clientWithRoute (Proxy :: Proxy sublayout) q t
309− (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
310382
311383 where pname = symbolVal (Proxy :: Proxy sym)
312384 --p prm = QueryPartParam $ (fmap . fmap) (toQueryParam) prm
@@ -350,8 +422,8 @@ instance (KnownSymbol sym, ToHttpApiData a, HasClient t m sublayout tag, Reflex
350422 type Client t m (QueryParams sym a :> sublayout) tag =
351423 Dynamic t [a] -> Client t m sublayout tag
352424
353− clientWithRoute Proxy q t req baseurl paramlist =
354− 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
355427
356428 where req' = req { qParams = (T.pack pname, params') : qParams req }
357429 pname = symbolVal (Proxy :: Proxy sym)
@@ -390,8 +462,8 @@ instance (KnownSymbol sym, HasClient t m sublayout tag, Reflex t)
390462 type Client t m (QueryFlag sym :> sublayout) tag =
391463 Dynamic t Bool -> Client t m sublayout tag
392464
393− clientWithRoute Proxy q t req baseurl flag =
394− 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
395467
396468 where req' = req { qParams = thisPair : qParams req }
397469 thisPair = (T.pack pName, QueryPartFlag flag) :: (Text, QueryPart t)
@@ -405,7 +477,7 @@ instance SupportsServantReflex t m => HasClient t m Raw tag where
405477 -> Event t tag
406478 -> m (Event t (ReqResult tag ()))
407479
408− clientWithRoute _ _ _ _ baseurl xhrs triggers = do
480+ clientWithRouteAndResultHandler _ _ _ _ baseurl _ wrap xhrs triggers = do
409481
410482 let xhrs' = liftA2 (\x path -> case x of
411483 Left e -> Left e
@@ -416,7 +488,7 @@ instance SupportsServantReflex t m => HasClient t m Raw tag where
416488 okReq = fmapMaybe (\(t,x) -> either (const Nothing) (Just . (t,)) x) xhrs'' :: Event t (tag, XhrRequest ())
417489
418490 resps <- performRequestsAsync okReq
419− return $ leftmost [ uncurry RequestFailure <$> badReq
491+ wrap $ leftmost [ uncurry RequestFailure <$> badReq
420492 , evalResponse (const $ Right ()) <$> resps
421493 ]
422494
@@ -447,8 +519,8 @@ instance (MimeRender ct a, HasClient t m sublayout tag, Reflex t)
447519 type Client t m (ReqBody (ct ': cts) a :> sublayout) tag =
448520 Dynamic t (Either Text a) -> Client t m sublayout tag
449521
450− clientWithRoute Proxy q t req baseurl body =
451− 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
452524 where req' = req { reqBody = bodyBytesCT }
453525 ctProxy = Proxy :: Proxy ct
454526 ctString = T.pack $ show $ contentType ctProxy
@@ -462,9 +534,9 @@ instance (MimeRender ct a, HasClient t m sublayout tag, Reflex t)
462534instance (KnownSymbol path, HasClient t m sublayout tag, Reflex t) => HasClient t m (path :> sublayout) tag where
463535 type Client t m (path :> sublayout) tag = Client t m sublayout tag
464536
465− clientWithRoute Proxy q t req baseurl =
466− clientWithRoute (Proxy :: Proxy sublayout) q t
467− (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
468540
469541 where p = symbolVal (Proxy :: Proxy path)
470542
@@ -472,23 +544,23 @@ instance (KnownSymbol path, HasClient t m sublayout tag, Reflex t) => HasClient
472544instance HasClient t m api tag => HasClient t m (Vault :> api) tag where
473545 type Client t m (Vault :> api) tag = Client t m api tag
474546
475− clientWithRoute Proxy q t req baseurl =
476− clientWithRoute (Proxy :: Proxy api) q t req baseurl
547+ clientWithRouteAndResultHandler Proxy =
548+ clientWithRouteAndResultHandler (Proxy :: Proxy api)
477549
478550
479551instance HasClient t m api tag => HasClient t m (RemoteHost :> api) tag where
480552 type Client t m (RemoteHost :> api) tag = Client t m api tag
481553
482− clientWithRoute Proxy q t req baseurl =
483− clientWithRoute (Proxy :: Proxy api) q t req baseurl
554+ clientWithRouteAndResultHandler Proxy =
555+ clientWithRouteAndResultHandler (Proxy :: Proxy api)
484556
485557
486558
487559instance HasClient t m api tag => HasClient t m (IsSecure :> api) tag where
488560 type Client t m (IsSecure :> api) tag = Client t m api tag
489561
490− clientWithRoute Proxy q t req baseurl =
491− clientWithRoute (Proxy :: Proxy api) q t req baseurl
562+ clientWithRouteAndResultHandler Proxy =
563+ clientWithRouteAndResultHandler (Proxy :: Proxy api)
492564
493565
494566instance (HasClient t m api tag, Reflex t)
@@ -497,8 +569,8 @@ instance (HasClient t m api tag, Reflex t)
497569 type Client t m (BasicAuth realm usr :> api) tag = Dynamic t (Maybe BasicAuthData)
498570 -> Client t m api tag
499571
500− clientWithRoute Proxy q t req baseurl authdata =
501− 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
502574 where
503575 req' = req { authData = Just authdata }
504576
@@ -524,3 +596,29 @@ non-empty lists, but is otherwise more specific, no instance will be overall
524596more specific. This in turn generally means adding yet another instance (one
525597for empty and one for non-empty lists).
526598-}
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