@@ -1,17 +1,23 @@
1−{-# LANGUAGE AllowAmbiguousTypes #-}
2−{-# LANGUAGE CPP #-}
3−{-# LANGUAGE DataKinds #-}
4−{-# LANGUAGE FlexibleContexts #-}
5−{-# LANGUAGE FlexibleInstances #-}
6−{-# LANGUAGE InstanceSigs #-}
7−{-# LANGUAGE MultiParamTypeClasses #-}
8−{-# LANGUAGE OverloadedStrings #-}
9−{-# LANGUAGE PolyKinds #-}
10−{-# LANGUAGE ScopedTypeVariables #-}
11−{-# LANGUAGE TupleSections #-}
12−{-# LANGUAGE TypeFamilies #-}
13−{-# LANGUAGE TypeOperators #-}
14−{-# 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
1521
1622-- #include "overlapping-compat.h"
1723-- | This module provides 'client' which can automatically generate
@@ -19,55 +25,70 @@
1925-- API.
2026module Servant.Reflex
2127 ( client
28+ , clientWithOpts
29+ , clientWithOptsAndResultHandler
30+ , clientWithRoute
31+ , clientWithRouteAndResultHandler
2232 , BuildHeaderKeysTo(..)
2333 , toHeaders
24− , HasClient(..)
34+ , HasClient
35+ , Client
2536 , module Servant.Common.Req
2637 , module Servant.Common.BaseUrl
2738 ) where
2839
2940------------------------------------------------------------------------------
3041import Control.Applicative
31−import Data.CaseInsensitive (mk)
42+import qualified Data.CaseInsensitive as CI
3243import Data.Functor.Identity
33−import qualified Data.Map as Map
34−import Data.Monoid ((<>))
35−import Data.Proxy (Proxy (..))
36−import qualified Data.Set as Set
37−import Data.Text (Text)
38−import qualified Data.Text as T
39−import qualified Data.Text.Encoding as E
40−import GHC.TypeLits (KnownSymbol, symbolVal)
41−import Servant.API ((:<|>) (..), (:>), BasicAuth,
42− BasicAuthData, BuildHeadersTo (..),
43− Capture, Header, Headers (..),
44− HttpVersion, IsSecure, MimeRender (..),
45− MimeUnrender, NoContent, QueryFlag,
46− QueryParam, QueryParams, Raw,
47− ReflectMethod (..), RemoteHost,
48− ReqBody, ToHttpApiData (..), Vault,
49− Verb, contentType)
50−
51−import Reflex.Dom (Dynamic, Event, Reflex,
52− XhrRequest (..), XhrResponse (..),
53− XhrResponseHeaders (..),
54− attachPromptlyDynWith, constDyn, ffor,
55− fmapMaybe, leftmost,
56− performRequestsAsync)
44+import qualified Data.Map as Map
45+import Data.Monoid ((<>))
46+import Data.Proxy (Proxy (..))
47+import qualified Data.Set as Set
48+import Data.Text (Text)
49+import qualified Data.Text as T
50+import qualified Data.Text.Encoding as E
51+import GHC.Exts (Constraint)
52+import GHC.TypeLits (KnownSymbol, symbolVal)
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 (..),
60+ RemoteHost, ReqBody,
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)
5772------------------------------------------------------------------------------
58−import Servant.Common.BaseUrl (BaseUrl (..), Scheme (..),
59− SupportsServantReflex, baseUrlWidget,
60− showBaseUrl)
61−import Servant.Common.Req (QParam (..), QueryPart (..), Req,
62− ReqResult (..), addHeader, authData,
63− defReq, evalResponse,
64− performRequestsCT,
65− performRequestsNoBody,
66− performSomeRequestsAsync,
67− prependToPathParts, qParamToQueryPart,
68− qParams, reqBody, reqFailure,
69− reqMethod, reqSuccess, reqTag,
70− respHeaders, response)
73+import Servant.Common.BaseUrl (BaseUrl(..), Scheme(..), baseUrlWidget,
74+ showBaseUrl,
75+ SupportsServantReflex)
76+import Servant.Common.Req (ClientOptions(..),
77+ defaultClientOptions,
78+ Req, ReqResult(..), QParam(..),
79+ QueryPart(..), addHeader, authData,
80+ defReq, evalResponse, prependToPathParts,
81+ -- performRequestCT,
82+ performRequestsCT,
83+ -- performRequestNoBody,
84+ performRequestsNoBody,
85+ performSomeRequestsAsync,
86+ qParamToQueryPart, reqBody,
87+ reqSuccess, reqFailure,
88+ reqMethod, respHeaders,
89+ response,
90+ reqTag,
91+ qParams, withCredentials)
7192
7293
7394-- * Accessing APIs as a Client
@@ -82,28 +103,75 @@ import Servant.Common.Req (QParam (..), QueryPart (..), Req,
82103-- >
83104-- > getAllBooks :: Event t l -> m (Event t (l, ReqResult [Book]))
84105-- > postNewBook :: Dynamic t (Maybe Book) -> Event t l
85−-- -> m (Event t (l, ReqResult Book)))
106+-- > -> m (Event t (l, ReqResult Book)))
86107-- > (getAllBooks :<|> postNewBook) = client myApi host
87108-- > where host = constDyn $ BaseUrl Http "localhost" 8080
88−client :: (HasClient t m layout tag)
89− => Proxy layout -> Proxy m -> Proxy tag -> Dynamic t BaseUrl -> Client t m layout tag
90−client p q t = clientWithRoute p q t defReq
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
91141
92142
93143-- | This class lets us define how each API combinator
94144-- influences the creation of an HTTP request. It's mostly
95145-- an internal class, you can just use 'client'.
96−class HasClient t m layout (tag :: *) where
146+class Monad m => HasClient t m layout (tag :: *) where
97147 type Client t m layout tag :: *
98− 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
99167
100168
101169instance (HasClient t m a tag, HasClient t m b tag) => HasClient t m (a :<|> b) tag where
102170 type Client t m (a :<|> b) tag = Client t m a tag :<|> Client t m b tag
103171
104− clientWithRoute Proxy q pTag req baseurl =
105− clientWithRoute (Proxy :: Proxy a) q pTag req baseurl :<|>
106− 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
107175
108176
109177-- Capture. Example:
@@ -124,12 +192,10 @@ instance (SupportsServantReflex t m, ToHttpApiData a, HasClient t m sublayout ta
124192 type Client t m (Capture capture a :> sublayout) tag =
125193 Dynamic t (Either Text a) -> Client t m sublayout tag
126194
127− clientWithRoute Proxy q t req baseurl val =
128− clientWithRoute (Proxy :: Proxy sublayout)
129− q t
130− (prependToPathParts p req)
131− baseurl
132− where p = (fmap . fmap) toUrlPiece val
195+ clientWithRouteAndResultHandler Proxy q t req baseurl opts wrap val =
196+ clientWithRouteAndResultHandler
197+ (Proxy :: Proxy sublayout) q t (prependToPathParts p req) baseurl opts wrap
198+ where p = (fmap . fmap) (toUrlPiece) val
133199
134200
135201-- VERB (Returning content) --
@@ -141,9 +207,8 @@ instance {-# OVERLAPPABLE #-}
141207 Event t tag -> m (Event t (ReqResult tag a))
142208 -- TODO how to access input types here?
143209 -- ExceptT ServantError IO a
144− clientWithRoute Proxy _ _ req baseurl trigs =
145− -- performRequestCT (Proxy :: Proxy ct) method req' baseurl trigs
146− 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
147212 where method = E.decodeUtf8 $ reflectMethod (Proxy :: Proxy method)
148213 req' = req { reqMethod = method }
149214
@@ -156,29 +221,33 @@ instance {-# OVERLAPPING #-}
156221 Event t tag -> m (Event t (ReqResult tag NoContent))
157222 -- TODO: how to access input types here?
158223 -- ExceptT ServantError IO NoContent
159− clientWithRoute Proxy _ _ req baseurl =
160− (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
161226 where method = E.decodeUtf8 $ reflectMethod (Proxy :: Proxy method)
162227
163228
164229toHeaders :: BuildHeadersTo ls => ReqResult tag a -> ReqResult tag (Headers ls a)
165230toHeaders r =
166− let toBS = E.encodeUtf8
167− hdrs = maybe []
168− (\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))
169233 (Map.toList $ _xhrResponse_headers xhr))
170234 (response r)
171235 in ffor r $ \a -> Headers {getResponse = a ,getHeadersHList = buildHeadersTo hdrs}
172236
237+
173238class BuildHeaderKeysTo hs where
174− buildHeaderKeysTo :: Proxy hs -> [T.Text]
239+ buildHeaderKeysTo :: Proxy hs -> [CI.CI T.Text]
175240
176241instance {-# OVERLAPPABLE #-} BuildHeaderKeysTo '[]
177242 where buildHeaderKeysTo _ = []
178243
179244instance {-# OVERLAPPABLE #-} (BuildHeaderKeysTo xs, KnownSymbol h)
180245 => BuildHeaderKeysTo ((Header h v) ': xs) where
181− 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+
182251
183252-- HEADERS Verb (Content) --
184253-- Headers combinator not treated in fully general case,
@@ -193,10 +262,10 @@ instance {-# OVERLAPPABLE #-}
193262 ) => HasClient t m (Verb method status cts' (Headers ls a)) tag where
194263 type Client t m (Verb method status cts' (Headers ls a)) tag =
195264 Event t tag -> m (Event t (ReqResult tag (Headers ls a)))
196− clientWithRoute Proxy _ _ req baseurl trigs = do
265+ clientWithRouteAndResultHandler Proxy _ _ req baseurl opts wrap trigs = do
197266 let method = E.decodeUtf8 $ reflectMethod (Proxy :: Proxy method)
198− resp <- fmap runIdentity <$> performRequestsCT (Proxy :: Proxy ct) method (constDyn $ Identity req') baseurl trigs
199− return $ toHeaders <$> resp
267+ resp <- fmap runIdentity <$> performRequestsCT (Proxy :: Proxy ct) method (constDyn $ Identity req') baseurl opts trigs
268+ wrap $ toHeaders <$> resp
200269 where req' = req { respHeaders =
201270 OnlyHeaders (Set.fromList (buildHeaderKeysTo (Proxy :: Proxy ls)))
202271 }
@@ -209,10 +278,10 @@ instance {-# OVERLAPPABLE #-}
209278 ) => HasClient t m (Verb method status cts (Headers ls NoContent)) tag where
210279 type Client t m (Verb method status cts (Headers ls NoContent)) tag
211280 = Event t tag -> m (Event t (ReqResult tag (Headers ls NoContent)))
212− clientWithRoute Proxy _ _ req baseurl trigs = do
281+ clientWithRouteAndResultHandler Proxy _ _ req baseurl opts wrap trigs = do
213282 let method = E.decodeUtf8 $ reflectMethod (Proxy :: Proxy method)
214− resp <- fmap runIdentity <$> performRequestsNoBody method (constDyn $ Identity req') baseurl trigs
215− return $ toHeaders <$> resp
283+ resp <- fmap runIdentity <$> performRequestsNoBody method (constDyn $ Identity req') baseurl opts trigs
284+ wrap $ toHeaders <$> resp
216285 where req' = req {respHeaders =
217286 OnlyHeaders (Set.fromList (buildHeaderKeysTo (Proxy :: Proxy ls)))
218287 }
@@ -239,11 +308,11 @@ instance (KnownSymbol sym, ToHttpApiData a,
239308 type Client t m (Header sym a :> sublayout) tag =
240309 Dynamic t (Either Text a) -> Client t m sublayout tag
241310
242− clientWithRoute Proxy q t req baseurl eVal =
243− clientWithRoute (Proxy :: Proxy sublayout)
244− q t
245− (Servant.Common.Req.addHeader hname eVal req)
246− 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
247316 where hname = T.pack $ symbolVal (Proxy :: Proxy sym)
248317
249318
@@ -257,8 +326,21 @@ instance HasClient t m sublayout tag
257326 type Client t m (HttpVersion :> sublayout) tag =
258327 Client t m sublayout tag
259328
260− clientWithRoute Proxy =
261− clientWithRoute (Proxy :: Proxy sublayout)
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+
262344
263345
264346-- | If you use a 'QueryParam' in one of your endpoints in your API,
@@ -288,15 +370,15 @@ instance HasClient t m sublayout tag
288370-- > -- 'getBooksBy Nothing' for all books
289371-- > -- 'getBooksBy (Just "Isaac Asimov")' to get all books by Isaac Asimov
290372instance (KnownSymbol sym, ToHttpApiData a, HasClient t m sublayout tag, Reflex t)
291− => HasClient t m (QueryParam sym a :> sublayout) tag where
373+ => HasClient t m (QueryParam' mods sym a :> sublayout) tag where
292374
293− type Client t m (QueryParam sym a :> sublayout) tag =
375+ type Client t m (QueryParam' mods sym a :> sublayout) tag =
294376 Dynamic t (QParam a) -> Client t m sublayout tag
295377
296378 -- if mparam = Nothing, we don't add it to the query string
297− clientWithRoute Proxy q t req baseurl mparam =
298− clientWithRoute (Proxy :: Proxy sublayout) q t
299− (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
300382
301383 where pname = symbolVal (Proxy :: Proxy sym)
302384 --p prm = QueryPartParam $ (fmap . fmap) (toQueryParam) prm
@@ -340,8 +422,8 @@ instance (KnownSymbol sym, ToHttpApiData a, HasClient t m sublayout tag, Reflex
340422 type Client t m (QueryParams sym a :> sublayout) tag =
341423 Dynamic t [a] -> Client t m sublayout tag
342424
343− clientWithRoute Proxy q t req baseurl paramlist =
344− 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
345427
346428 where req' = req { qParams = (T.pack pname, params') : qParams req }
347429 pname = symbolVal (Proxy :: Proxy sym)
@@ -380,8 +462,8 @@ instance (KnownSymbol sym, HasClient t m sublayout tag, Reflex t)
380462 type Client t m (QueryFlag sym :> sublayout) tag =
381463 Dynamic t Bool -> Client t m sublayout tag
382464
383− clientWithRoute Proxy q t req baseurl flag =
384− 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
385467
386468 where req' = req { qParams = thisPair : qParams req }
387469 thisPair = (T.pack pName, QueryPartFlag flag) :: (Text, QueryPart t)
@@ -395,7 +477,7 @@ instance SupportsServantReflex t m => HasClient t m Raw tag where
395477 -> Event t tag
396478 -> m (Event t (ReqResult tag ()))
397479
398− clientWithRoute _ _ _ _ baseurl xhrs triggers = do
480+ clientWithRouteAndResultHandler _ _ _ _ baseurl _ wrap xhrs triggers = do
399481
400482 let xhrs' = liftA2 (\x path -> case x of
401483 Left e -> Left e
@@ -406,7 +488,7 @@ instance SupportsServantReflex t m => HasClient t m Raw tag where
406488 okReq = fmapMaybe (\(t,x) -> either (const Nothing) (Just . (t,)) x) xhrs'' :: Event t (tag, XhrRequest ())
407489
408490 resps <- performRequestsAsync okReq
409− return $ leftmost [ uncurry RequestFailure <$> badReq
491+ wrap $ leftmost [ uncurry RequestFailure <$> badReq
410492 , evalResponse (const $ Right ()) <$> resps
411493 ]
412494
@@ -437,8 +519,8 @@ instance (MimeRender ct a, HasClient t m sublayout tag, Reflex t)
437519 type Client t m (ReqBody (ct ': cts) a :> sublayout) tag =
438520 Dynamic t (Either Text a) -> Client t m sublayout tag
439521
440− clientWithRoute Proxy q t req baseurl body =
441− 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
442524 where req' = req { reqBody = bodyBytesCT }
443525 ctProxy = Proxy :: Proxy ct
444526 ctString = T.pack $ show $ contentType ctProxy
@@ -452,9 +534,9 @@ instance (MimeRender ct a, HasClient t m sublayout tag, Reflex t)
452534instance (KnownSymbol path, HasClient t m sublayout tag, Reflex t) => HasClient t m (path :> sublayout) tag where
453535 type Client t m (path :> sublayout) tag = Client t m sublayout tag
454536
455− clientWithRoute Proxy q t req =
456− clientWithRoute (Proxy :: Proxy sublayout) q t
457− (prependToPathParts (pure (Right $ T.pack p)) req)
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
458540
459541 where p = symbolVal (Proxy :: Proxy path)
460542
@@ -462,23 +544,23 @@ instance (KnownSymbol path, HasClient t m sublayout tag, Reflex t) => HasClient
462544instance HasClient t m api tag => HasClient t m (Vault :> api) tag where
463545 type Client t m (Vault :> api) tag = Client t m api tag
464546
465− clientWithRoute Proxy =
466− clientWithRoute (Proxy :: Proxy api)
547+ clientWithRouteAndResultHandler Proxy =
548+ clientWithRouteAndResultHandler (Proxy :: Proxy api)
467549
468550
469551instance HasClient t m api tag => HasClient t m (RemoteHost :> api) tag where
470552 type Client t m (RemoteHost :> api) tag = Client t m api tag
471553
472− clientWithRoute Proxy =
473− clientWithRoute (Proxy :: Proxy api)
554+ clientWithRouteAndResultHandler Proxy =
555+ clientWithRouteAndResultHandler (Proxy :: Proxy api)
474556
475557
476558
477559instance HasClient t m api tag => HasClient t m (IsSecure :> api) tag where
478560 type Client t m (IsSecure :> api) tag = Client t m api tag
479561
480− clientWithRoute Proxy =
481− clientWithRoute (Proxy :: Proxy api)
562+ clientWithRouteAndResultHandler Proxy =
563+ clientWithRouteAndResultHandler (Proxy :: Proxy api)
482564
483565
484566instance (HasClient t m api tag, Reflex t)
@@ -487,8 +569,8 @@ instance (HasClient t m api tag, Reflex t)
487569 type Client t m (BasicAuth realm usr :> api) tag = Dynamic t (Maybe BasicAuthData)
488570 -> Client t m api tag
489571
490− clientWithRoute Proxy q t req baseurl authdata =
491− 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
492574 where
493575 req' = req { authData = Just authdata }
494576
@@ -514,3 +596,29 @@ non-empty lists, but is otherwise more specific, no instance will be overall
514596more specific. This in turn generally means adding yet another instance (one
515597for empty and one for non-empty lists).
516598-}
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