@@ -1,16 +1,23 @@
1−{-# LANGUAGE CPP #-}
2−{-# LANGUAGE DataKinds #-}
3−{-# LANGUAGE FlexibleContexts #-}
4−{-# LANGUAGE FlexibleInstances #-}
5−{-# LANGUAGE InstanceSigs #-}
6−{-# LANGUAGE MultiParamTypeClasses #-}
7−{-# LANGUAGE OverloadedStrings #-}
8−{-# LANGUAGE PolyKinds #-}
9−{-# LANGUAGE ScopedTypeVariables #-}
10−{-# LANGUAGE TupleSections #-}
11−{-# LANGUAGE TypeFamilies #-}
12−{-# LANGUAGE TypeOperators #-}
13−{-# 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
1421
1522-- #include "overlapping-compat.h"
1623-- | This module provides 'client' which can automatically generate
@@ -18,47 +25,71 @@
1825-- API.
1926module Servant.Reflex
2027 ( client
21− , HasClient(..)
28+ , clientWithOpts
29+ , clientWithOptsAndResultHandler
30+ , clientWithRoute
31+ , clientWithRouteAndResultHandler
32+ , BuildHeaderKeysTo(..)
33+ , toHeaders
34+ , HasClient
35+ , Client
2236 , module Servant.Common.Req
2337 , module Servant.Common.BaseUrl
2438 ) where
2539
26−-------------------------------------------------------------------------------
40+------------------------------------------------------------------------------
2741import Control.Applicative
28−import Data.CaseInsensitive (mk)
29−import qualified Data.Map as Map
30−import Data.Monoid ((<>))
31−import Data.Proxy (Proxy (..))
32−import qualified Data.Set as Set
33−import Data.Text (Text)
34−import qualified Data.Text as T
35−import qualified Data.Text.Encoding as E
36−import GHC.TypeLits (KnownSymbol, symbolVal)
37−import Reflex.Dom (Dynamic, Event, Reflex,
38− XhrRequest (..), XhrResponse (..),
39− XhrResponseHeaders (..), ffor,
40− fmapMaybe, leftmost,
41− performRequestAsync, tagPromptlyDyn)
42−import Servant.API ((:<|>) (..), (:>), BasicAuth,
43− BasicAuthData, BuildHeadersTo (..),
44− Capture, Header, Headers (..),
45− HttpVersion, IsSecure, MimeRender (..),
46− MimeUnrender, NoContent, QueryFlag,
47− QueryParam, QueryParams, Raw,
48− ReflectMethod (..), RemoteHost,
49− ReqBody, ToHttpApiData (..), Vault,
50− Verb, contentType)
51−import Servant.Common.BaseUrl (BaseUrl (..), Scheme (..),
52− SupportsServantReflex, baseUrlWidget,
53− showBaseUrl)
54−import Servant.Common.Req (QParam (..), QueryPart (..), Req,
55− ReqResult (..), addHeader, authData,
56− defReq, performRequestCT,
57− performRequestNoBody,
58− prependToPathParts, qParamToQueryPart,
59− qParams, reqBody, reqFailure,
60− reqMethod, reqSuccess, respHeaders,
61− response)
42+import qualified Data.CaseInsensitive as CI
43+import Data.Functor.Identity
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)
72+------------------------------------------------------------------------------
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)
92+
6293
6394-- * Accessing APIs as a Client
6495
@@ -70,28 +101,78 @@ import Servant.Common.Req (QParam (..), QueryPart (..), Req,
70101-- > myApi :: Proxy MyApi
71102-- > myApi = Proxy
72103-- >
73−-- > getAllBooks :: Event t () -> m (Event t (Either XhrError ((),[Book])))
74−-- > postNewBook :: Dynamic t (Maybe Book) -> Event t ()
75−-- -> m (Event t (Either XhrError (Book,Book)))
104+-- > getAllBooks :: Event t l -> m (Event t (l, ReqResult [Book]))
105+-- > postNewBook :: Dynamic t (Maybe Book) -> Event t l
106+-- > -> m (Event t (l, ReqResult Book)))
76107-- > (getAllBooks :<|> postNewBook) = client myApi host
77108-- > where host = constDyn $ BaseUrl Http "localhost" 8080
78−client :: (HasClient t m layout)
79− => Proxy layout -> Proxy m -> Dynamic t BaseUrl -> Client t m layout
80−client p q = clientWithRoute p q 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
141+
81142
82143-- | This class lets us define how each API combinator
83144-- influences the creation of an HTTP request. It's mostly
84145-- an internal class, you can just use 'client'.
85−class HasClient t m layout where
86− type Client t m layout :: *
87− clientWithRoute :: Proxy layout -> Proxy m -> Req t -> Dynamic t BaseUrl -> Client t m layout
88−
146+class Monad m => HasClient t m layout (tag :: *) where
147+ type 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
167+
168+
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
171+
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
89175
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
95176
96177-- Capture. Example:
97178-- > 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
101182-- > getBook :: SupportsServantReflex t m
102183-- => Dynamic t BaseUrl
103184-- -> Dynamic t (Maybe Text)
104−-- -> Event t ()
105−-- -> m (Event t (Either XhrError (Text, Book)))
185+-- -> Event t l
186+-- -> m (Event t (l, ReqResult Book))
106187-- > 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
109188
110− type Client t m (Capture capture a :> sublayout) =
111− Dynamic t (Either Text a) -> Client t m sublayout
189+instance (SupportsServantReflex t m, ToHttpApiData a, HasClient t m sublayout tag)
190+ => HasClient t m (Capture capture a :> sublayout) tag where
112191
113− clientWithRoute Proxy q req baseurl val =
114− clientWithRoute (Proxy :: Proxy sublayout)
115− q
116− (prependToPathParts p req)
117− baseurl
192+ type Client t m (Capture capture a :> sublayout) tag =
193+ Dynamic t (Either Text a) -> Client t m sublayout tag
194+
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
118199
119− where p = (fmap . fmap) toUrlPiece val
120200
121201-- VERB (Returning content) --
122202instance {-# OVERLAPPABLE #-}
123203 -- Note [Non-Empty Content Types]
124204 (MimeUnrender ct a, ReflectMethod method, cts' ~ (ct ': cts), SupportsServantReflex t m
125− ) => HasClient t m (Verb method status cts' a) where
126− type Client t m (Verb method status cts' a) =
127− Event t () -> m (Event t (ReqResult a))
205+ ) => HasClient t m (Verb method status cts' a) tag where
206+ type Client t m (Verb method status cts' a) tag =
207+ Event t tag -> m (Event t (ReqResult tag a))
128208 -- TODO how to access input types here?
129209 -- ExceptT ServantError IO a
130− clientWithRoute Proxy _ req =
131− performRequestCT (Proxy :: Proxy ct) method req'
210+ clientWithRouteAndResultHandler Proxy _ _ req baseurl opts wrap trigs =
211+ wrap =<< fmap runIdentity <$> performRequestsCT (Proxy :: Proxy ct) method (constDyn $ Identity $ req') baseurl opts trigs
132212 where method = E.decodeUtf8 $ reflectMethod (Proxy :: Proxy method)
133213 req' = req { reqMethod = method }
134214
215+
135216-- -- VERB (No content) --
136217instance {-# OVERLAPPING #-}
137218 (ReflectMethod method, SupportsServantReflex t m) =>
138− HasClient t m (Verb method status cts NoContent) where
139− type Client t m (Verb method status cts NoContent) =
140− Event t () -> m (Event t (ReqResult NoContent))
219+ HasClient t m (Verb method status cts NoContent) tag where
220+ type Client t m (Verb method status cts NoContent) tag =
221+ Event t tag -> m (Event t (ReqResult tag NoContent))
141222 -- TODO: how to access input types here?
142223 -- ExceptT ServantError IO NoContent
143− clientWithRoute Proxy _ =
144− performRequestNoBody method
224+ clientWithRouteAndResultHandler Proxy _ _ req baseurl opts wrap trigs =
225+ wrap =<< fmap runIdentity <$> performRequestsNoBody method (constDyn $ Identity req) baseurl opts trigs
145226 where method = E.decodeUtf8 $ reflectMethod (Proxy :: Proxy method)
146227
147−toHeaders :: BuildHeadersTo ls => ReqResult a -> ReqResult (Headers ls a)
228+
229+toHeaders :: BuildHeadersTo ls => ReqResult tag a -> ReqResult tag (Headers ls a)
148230toHeaders r =
149− let toBS = E.encodeUtf8
150− hdrs = maybe []
151− (\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))
152233 (Map.toList $ _xhrResponse_headers xhr))
153234 (response r)
154235 in ffor r $ \a -> Headers {getResponse = a ,getHeadersHList = buildHeadersTo hdrs}
155236
237+
156238class BuildHeaderKeysTo hs where
157− buildHeaderKeysTo :: Proxy hs -> [T.Text]
239+ buildHeaderKeysTo :: Proxy hs -> [CI.CI T.Text]
158240
159241instance {-# OVERLAPPABLE #-} BuildHeaderKeysTo '[]
160242 where buildHeaderKeysTo _ = []
161243
162244instance {-# OVERLAPPABLE #-} (BuildHeaderKeysTo xs, KnownSymbol h)
163− => BuildHeaderKeysTo '[(Header h v) ': xs] where
164− buildHeaderKeysTo _ = T.pack (symbolVal (Proxy :: Proxy h)) : buildHeaderKeysTo (Proxy :: Proxy xs)
245+ => BuildHeaderKeysTo ((Header h v) ': xs) where
246+ buildHeaderKeysTo _ =
247+ let
248+ thisKey = CI.mk $ T.pack (symbolVal (Proxy :: Proxy h))
249+ in thisKey : buildHeaderKeysTo (Proxy :: Proxy xs)
250+
165251
166252-- HEADERS Verb (Content) --
167253-- Headers combinator not treated in fully general case,
@@ -173,33 +259,35 @@ instance {-# OVERLAPPABLE #-}
173259 ( MimeUnrender ct a, BuildHeadersTo ls, BuildHeaderKeysTo ls,
174260 ReflectMethod method, cts' ~ (ct ': cts),
175261 SupportsServantReflex t m
176− ) => HasClient t m (Verb method status cts' (Headers ls a)) where
177− type Client t m (Verb method status cts' (Headers ls a)) =
178− Event t () -> m (Event t (ReqResult (Headers ls a)))
179− clientWithRoute Proxy _ req baseurl = do
262+ ) => HasClient t m (Verb method status cts' (Headers ls a)) tag where
263+ type Client t m (Verb method status cts' (Headers ls a)) tag =
264+ Event t tag -> m (Event t (ReqResult tag (Headers ls a)))
265+ clientWithRouteAndResultHandler Proxy _ _ req baseurl opts wrap trigs = do
180266 let method = E.decodeUtf8 $ reflectMethod (Proxy :: Proxy method)
181− resp <- performRequestCT (Proxy :: Proxy ct) method req' baseurl
182− return $ (fmap . fmap) toHeaders resp
267+ resp <- fmap runIdentity <$> performRequestsCT (Proxy :: Proxy ct) method (constDyn $ Identity req') baseurl opts trigs
268+ wrap $ toHeaders <$> resp
183269 where req' = req { respHeaders =
184270 OnlyHeaders (Set.fromList (buildHeaderKeysTo (Proxy :: Proxy ls)))
185271 }
186272
273+
187274-- HEADERS Verb (No content) --
188275instance {-# OVERLAPPABLE #-}
189276 ( BuildHeadersTo ls, BuildHeaderKeysTo ls, ReflectMethod method,
190277 SupportsServantReflex t m
191− ) => HasClient t m (Verb method status cts (Headers ls NoContent)) where
192− type Client t m (Verb method status cts (Headers ls NoContent))
193− = Event t () -> m (Event t (ReqResult (Headers ls NoContent)))
194− clientWithRoute Proxy _ req baseurl = do
278+ ) => HasClient t m (Verb method status cts (Headers ls NoContent)) tag where
279+ type Client t m (Verb method status cts (Headers ls NoContent)) tag
280+ = Event t tag -> m (Event t (ReqResult tag (Headers ls NoContent)))
281+ clientWithRouteAndResultHandler Proxy _ _ req baseurl opts wrap trigs = do
195282 let method = E.decodeUtf8 $ reflectMethod (Proxy :: Proxy method)
196− resp <- performRequestNoBody method req' baseurl
197− return $ (fmap . fmap) toHeaders resp
283+ resp <- fmap runIdentity <$> performRequestsNoBody method (constDyn $ Identity req') baseurl opts trigs
284+ wrap $ toHeaders <$> resp
198285 where req' = req {respHeaders =
199286 OnlyHeaders (Set.fromList (buildHeaderKeysTo (Proxy :: Proxy ls)))
200287 }
201288
202289
290+
203291-- HEADER
204292-- > newtype Referer = Referer { referrer :: Text }
205293-- > deriving (Eq, Show, Generic, FromText, ToHttpApiData)
@@ -214,28 +302,45 @@ instance {-# OVERLAPPABLE #-}
214302-- > -- then you can just use "viewRefer" to query that endpoint
215303-- > -- specifying Nothing or e.g Just "http://haskell.org/" as arguments
216304instance (KnownSymbol sym, ToHttpApiData a,
217− HasClient t m sublayout, SupportsServantReflex t m)
218− => HasClient t m (Header sym a :> sublayout) where
305+ HasClient t m sublayout tag, SupportsServantReflex t m)
306+ => HasClient t m (Header sym a :> sublayout) tag where
219307
220− type Client t m (Header sym a :> sublayout) =
221− Dynamic t (Either Text a) -> Client t m sublayout
308+ type Client t m (Header sym a :> sublayout) tag =
309+ Dynamic t (Either Text a) -> Client t m sublayout tag
222310
223− clientWithRoute Proxy q req baseurl eVal =
224− clientWithRoute (Proxy :: Proxy sublayout)
225− q
226− (Servant.Common.Req.addHeader hname eVal req)
227− 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
228316 where hname = T.pack $ symbolVal (Proxy :: Proxy sym)
229317
318+
319+
320+
230321-- | Using a 'HttpVersion' combinator in your API doesn't affect the client
231322-- functions.
232−instance HasClient t m sublayout
233− => HasClient t m (HttpVersion :> sublayout) where
323+instance HasClient t m sublayout tag
324+ => HasClient t m (HttpVersion :> sublayout) tag where
325+
326+ type Client t m (HttpVersion :> sublayout) tag =
327+ Client t m sublayout tag
328+
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)
234342
235− type Client t m (HttpVersion :> sublayout) =
236− Client t m sublayout
237343
238− clientWithRoute Proxy = clientWithRoute (Proxy :: Proxy sublayout)
239344
240345
241346-- | If you use a 'QueryParam' in one of your endpoints in your API,
@@ -264,16 +369,16 @@ instance HasClient t m sublayout
264369-- > -- then you can just use "getBooksBy" to query that endpoint.
265370-- > -- 'getBooksBy Nothing' for all books
266371-- > -- 'getBooksBy (Just "Isaac Asimov")' to get all books by Isaac Asimov
267−instance (KnownSymbol sym, ToHttpApiData a, HasClient t m sublayout, Reflex t)
268− => HasClient t m (QueryParam sym a :> sublayout) where
372+instance (KnownSymbol sym, ToHttpApiData a, HasClient t m sublayout tag, Reflex t)
373+ => HasClient t m (QueryParam' mods sym a :> sublayout) tag where
269374
270− type Client t m (QueryParam sym a :> sublayout) =
271− Dynamic t (QParam a) -> Client t m sublayout
375+ type Client t m (QueryParam' mods sym a :> sublayout) tag =
376+ Dynamic t (QParam a) -> Client t m sublayout tag
272377
273378 -- if mparam = Nothing, we don't add it to the query string
274− clientWithRoute Proxy q req baseurl mparam =
275− clientWithRoute (Proxy :: Proxy sublayout) q
276− (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
277382
278383 where pname = symbolVal (Proxy :: Proxy sym)
279384 --p prm = QueryPartParam $ (fmap . fmap) (toQueryParam) prm
@@ -281,6 +386,8 @@ instance (KnownSymbol sym, ToHttpApiData a, HasClient t m sublayout, Reflex t)
281386 p prm = QueryPartParam $ fmap qParamToQueryPart prm -- (fmap . fmap) (unpack . toQueryParam) prm
282387 paramPair = (T.pack pname, p mparam)
283388
389+
390+
284391-- | If you use a 'QueryParams' in one of your endpoints in your API,
285392-- the corresponding querying function will automatically take
286393-- 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)
309416-- > -- 'getBooksBy []' for all books
310417-- > -- 'getBooksBy ["Isaac Asimov", "Robert A. Heinlein"]'
311418-- > -- to get all books by Asimov and Heinlein
312−instance (KnownSymbol sym, ToHttpApiData a, HasClient t m sublayout, Reflex t)
313− => HasClient t m (QueryParams sym a :> sublayout) where
419+instance (KnownSymbol sym, ToHttpApiData a, HasClient t m sublayout tag, Reflex t)
420+ => HasClient t m (QueryParams sym a :> sublayout) tag where
314421
315− type Client t m (QueryParams sym a :> sublayout) =
316− Dynamic t [a] -> Client t m sublayout
422+ type Client t m (QueryParams sym a :> sublayout) tag =
423+ Dynamic t [a] -> Client t m sublayout tag
317424
318− clientWithRoute Proxy q req baseurl paramlist =
319− clientWithRoute (Proxy :: Proxy sublayout) q req' baseurl
425+ clientWithRouteAndResultHandler Proxy q t req baseurl opts wrap paramlist =
426+ clientWithRouteAndResultHandler (Proxy :: Proxy sublayout) q t req' baseurl opts wrap
320427
321428 where req' = req { qParams = (T.pack pname, params') : qParams req }
322429 pname = symbolVal (Proxy :: Proxy sym)
@@ -324,6 +431,7 @@ instance (KnownSymbol sym, ToHttpApiData a, HasClient t m sublayout, Reflex t)
324431 paramlist
325432
326433
434+
327435-- | If you use a 'QueryFlag' in one of your endpoints in your API,
328436-- the corresponding querying function will automatically take
329437-- an additional 'Bool' argument.
@@ -348,49 +456,42 @@ instance (KnownSymbol sym, ToHttpApiData a, HasClient t m sublayout, Reflex t)
348456-- > -- 'getBooksBy True' to only get _already published_ books
349457
350458-- TODO Bring back
351−instance (KnownSymbol sym, HasClient t m sublayout, Reflex t)
352− => HasClient t m (QueryFlag sym :> sublayout) where
459+instance (KnownSymbol sym, HasClient t m sublayout tag, Reflex t)
460+ => HasClient t m (QueryFlag sym :> sublayout) tag where
353461
354− type Client t m (QueryFlag sym :> sublayout) =
355− Dynamic t Bool -> Client t m sublayout
462+ type Client t m (QueryFlag sym :> sublayout) tag =
463+ Dynamic t Bool -> Client t m sublayout tag
356464
357− clientWithRoute Proxy q req baseurl flag =
358− clientWithRoute (Proxy :: Proxy sublayout) q req' baseurl
465+ clientWithRouteAndResultHandler Proxy q t req baseurl opts wrap flag =
466+ clientWithRouteAndResultHandler (Proxy :: Proxy sublayout) q t req' baseurl opts wrap
359467
360468 where req' = req { qParams = thisPair : qParams req }
361469 thisPair = (T.pack pName, QueryPartFlag flag) :: (Text, QueryPart t)
362470 pName = symbolVal (Proxy :: Proxy sym)
363471
364472
365−-- | Pick a 'Method' and specify where the server you want to query is. You get
366−-- back the full `Response`.
367−-- TODO redo
368−instance SupportsServantReflex t m => HasClient t m Raw where
369− type Client t m Raw = Dynamic t (Either Text (XhrRequest ()))
370− -> Event t ()
371− -> m (Event t (ReqResult ()))
372−
373− -- clientWithRoute :: Proxy Raw -> Proxy m -> Req -> BaseUrl -> Client t m Raw
374− clientWithRoute _ _ _ baseurl xhrs triggers = do
375− let xhrs' = liftA2 (\x path -> case x of
376− Left e -> Left e
377− Right jx -> Right $ jx {_xhrRequest_url = path
378− <> _xhrRequest_url jx})
379− xhrs
380− (showBaseUrl <$> baseurl)
381− reqs = tagPromptlyDyn xhrs' triggers
382− okReq = fmapMaybe hush reqs
383− badReq = fmapMaybe tattle reqs
384− resps <- performRequestAsync okReq
385− return $ leftmost [fmap (ResponseSuccess () ) resps
386− ,fmap RequestFailure badReq]
387−
388−
389−hush :: Either e a -> Maybe a
390−hush = either (const Nothing) Just
391−
392−tattle :: Either e a -> Maybe e
393−tattle = either Just (const Nothing)
473+
474+-- | Send a raw 'XhrRequest ()' directly to 'baseurl'
475+instance SupportsServantReflex t m => HasClient t m Raw tag where
476+ type Client t m Raw tag = Dynamic t (Either Text (XhrRequest ()))
477+ -> Event t tag
478+ -> m (Event t (ReqResult tag ()))
479+
480+ clientWithRouteAndResultHandler _ _ _ _ baseurl _ wrap xhrs triggers = do
481+
482+ let xhrs' = liftA2 (\x path -> case x of
483+ Left e -> Left e
484+ Right jx -> Right $ jx { _xhrRequest_url = path <> _xhrRequest_url jx }
485+ ) xhrs (showBaseUrl <$> baseurl)
486+ xhrs'' = attachPromptlyDynWith (flip (,)) xhrs' triggers :: Event t (tag, Either Text (XhrRequest ()))
487+ badReq = fmapMaybe (\(t,x) -> either (Just . (t,)) (const Nothing) x) xhrs'' :: Event t (tag, Text)
488+ okReq = fmapMaybe (\(t,x) -> either (const Nothing) (Just . (t,)) x) xhrs'' :: Event t (tag, XhrRequest ())
489+
490+ resps <- performRequestsAsync okReq
491+ wrap $ leftmost [ uncurry RequestFailure <$> badReq
492+ , evalResponse (const $ Right ()) <$> resps
493+ ]
494+
394495
395496-- | If you use a 'ReqBody' in one of your endpoints in your API,
396497-- the corresponding querying function will automatically take
@@ -412,14 +513,14 @@ tattle = either Just (const Nothing)
412513-- > where host = BaseUrl Http "localhost" 8080
413514-- > -- then you can just use "addBook" to query that endpoint
414515
415−instance (MimeRender ct a, HasClient t m sublayout, Reflex t)
416− => HasClient t m (ReqBody (ct ': cts) a :> sublayout) where
516+instance (MimeRender ct a, HasClient t m sublayout tag, Reflex t)
517+ => HasClient t m (ReqBody (ct ': cts) a :> sublayout) tag where
417518
418− type Client t m (ReqBody (ct ': cts) a :> sublayout) =
419− Dynamic t (Either Text a) -> Client t m sublayout
519+ type Client t m (ReqBody (ct ': cts) a :> sublayout) tag =
520+ Dynamic t (Either Text a) -> Client t m sublayout tag
420521
421− clientWithRoute Proxy q req baseurl body =
422− clientWithRoute (Proxy :: Proxy sublayout) q req' baseurl
522+ clientWithRouteAndResultHandler Proxy q t req baseurl opts wrap body =
523+ clientWithRouteAndResultHandler (Proxy :: Proxy sublayout) q t req' baseurl opts wrap
423524 where req' = req { reqBody = bodyBytesCT }
424525 ctProxy = Proxy :: Proxy ct
425526 ctString = T.pack $ show $ contentType ctProxy
@@ -427,39 +528,49 @@ instance (MimeRender ct a, HasClient t m sublayout, Reflex t)
427528 (\b -> (mimeRender ctProxy b, ctString))
428529 body
429530
531+
532+
430533-- | 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
432− type Client t m (path :> sublayout) = Client t m sublayout
534+instance (KnownSymbol path, HasClient t m sublayout tag, Reflex t) => HasClient t m (path :> sublayout) tag where
535+ type Client t m (path :> sublayout) tag = Client t m sublayout tag
433536
434− clientWithRoute Proxy q req =
435− clientWithRoute (Proxy :: Proxy sublayout) q
436− (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
437540
438541 where p = symbolVal (Proxy :: Proxy path)
439542
440−instance HasClient t m api => HasClient t m (Vault :> api) where
441− type Client t m (Vault :> api) = Client t m api
442543
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
546+
547+ clientWithRouteAndResultHandler Proxy =
548+ clientWithRouteAndResultHandler (Proxy :: Proxy api)
549+
550+
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
553+
554+ clientWithRouteAndResultHandler Proxy =
555+ clientWithRouteAndResultHandler (Proxy :: Proxy api)
444556
445−instance HasClient t m api => HasClient t m (RemoteHost :> api) where
446− type Client t m (RemoteHost :> api) = Client t m api
447557
448− clientWithRoute Proxy = clientWithRoute (Proxy :: Proxy api)
449558
450−instance HasClient t m api => HasClient t m (IsSecure :> api) where
451− type Client t m (IsSecure :> api) = Client t m api
559+instance HasClient t m api tag => HasClient t m (IsSecure :> api) tag where
560+ type Client t m (IsSecure :> api) tag = Client t m api tag
452561
453− clientWithRoute Proxy = clientWithRoute (Proxy :: Proxy api)
562+ clientWithRouteAndResultHandler Proxy =
563+ clientWithRouteAndResultHandler (Proxy :: Proxy api)
454564
455−instance (HasClient t m api, Reflex t)
456− => HasClient t m (BasicAuth realm usr :> api) where
457565
458− type Client t m (BasicAuth realm usr :> api) = Dynamic t (Maybe BasicAuthData)
459− -> Client t m api
566+instance (HasClient t m api tag, Reflex t)
567+ => HasClient t m (BasicAuth realm usr :> api) tag where
460568
461− clientWithRoute Proxy q req baseurl authdata =
462− clientWithRoute (Proxy :: Proxy api) q req' baseurl
569+ type Client t m (BasicAuth realm usr :> api) tag = Dynamic t (Maybe BasicAuthData)
570+ -> Client t m api tag
571+
572+ clientWithRouteAndResultHandler Proxy q t req baseurl opts wrap authdata =
573+ clientWithRouteAndResultHandler (Proxy :: Proxy api) q t req' baseurl opts wrap
463574 where
464575 req' = req { authData = Just authdata }
465576
@@ -485,3 +596,29 @@ non-empty lists, but is otherwise more specific, no instance will be overall
485596more specific. This in turn generally means adding yet another instance (one
486597for empty and one for non-empty lists).
487598-}
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