@@ -1,16 +1,23 @@
1−{-# LANGUAGE CPP #-}
2−{-# LANGUAGE DataKinds #-}
3−{-# LANGUAGE FlexibleContexts #-}
4−{-# LANGUAGE FlexibleInstances #-}
5−{-# LANGUAGE InstanceSigs #-}
6−{-# LANGUAGE OverloadedStrings #-}
7−{-# LANGUAGE PolyKinds #-}
8−{-# LANGUAGE ScopedTypeVariables #-}
9−{-# LANGUAGE TupleSections #-}
10−{-# LANGUAGE TypeFamilies #-}
11−{-# LANGUAGE TypeOperators #-}
12−{-# LANGUAGE UndecidableInstances #-}
13−{-# LANGUAGE MultiParamTypeClasses #-}
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,49 +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
42+import qualified Data.CaseInsensitive as CI
43+import Data.Functor.Identity
44+import qualified Data.Map as Map
2845import Data.Monoid ((<>))
29−import qualified Data.Set as Set
30−import qualified Data.Text.Encoding as E
31−import Data.CaseInsensitive (mk)
3246import Data.Proxy (Proxy (..))
33−import qualified Data.Map as Map
47+import qualified Data.Set as Set
3448import Data.Text (Text)
3549import qualified Data.Text as T
50+import qualified Data.Text.Encoding as E
51+import GHC.Exts (Constraint)
3652import GHC.TypeLits (KnownSymbol, symbolVal)
37−import Servant.API ((:<|>)(..),(:>), BasicAuth,
38− BasicAuthData, BuildHeadersTo(..),
39− Capture, contentType, Header,
40− Headers(..), HttpVersion, IsSecure,
41− MimeRender(..), MimeUnrender,
42− NoContent, QueryFlag, QueryParam,
43− 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 (..),
4460 RemoteHost, ReqBody,
45− ToHttpApiData(..), Vault, Verb)
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+------------------------------------------------------------------------------
4673import Servant.Common.BaseUrl (BaseUrl(..), Scheme(..), baseUrlWidget,
4774 showBaseUrl,
4875 SupportsServantReflex)
49−import Servant.Common.Req (Req, ReqResult(..), QParam(..),
76+import Servant.Common.Req (ClientOptions(..),
77+ defaultClientOptions,
78+ Req, ReqResult(..), QParam(..),
5079 QueryPart(..), addHeader, authData,
51− defReq, prependToPathParts,
52− performRequestCT,
53− performRequestNoBody,
80+ defReq, evalResponse, prependToPathParts,
81+ -- performRequestCT,
82+ performRequestsCT,
83+ -- performRequestNoBody,
84+ performRequestsNoBody,
85+ performSomeRequestsAsync,
5486 qParamToQueryPart, reqBody,
5587 reqSuccess, reqFailure,
56− reqMethod, respHeaders, response,
57− qParams)
58−import Reflex.Dom (Dynamic, Event, Reflex,
59− XhrRequest(..),
60− XhrResponseHeaders(..),
61− XhrResponse(..), ffor, fmapMaybe,
62− leftmost, performRequestAsync,
63− tagPromptlyDyn )
88+ reqMethod, respHeaders,
89+ response,
90+ reqTag,
91+ qParams, withCredentials)
92+
6493
6594-- * Accessing APIs as a Client
6695
@@ -72,28 +101,78 @@ import Reflex.Dom (Dynamic, Event, Reflex,
72101-- > myApi :: Proxy MyApi
73102-- > myApi = Proxy
74103-- >
75−-- > getAllBooks :: Event t () -> m (Event t (Either XhrError ((),[Book])))
76−-- > postNewBook :: Dynamic t (Maybe Book) -> Event t ()
77−-- -> 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)))
78107-- > (getAllBooks :<|> postNewBook) = client myApi host
79108-- > where host = constDyn $ BaseUrl Http "localhost" 8080
80−client :: (HasClient t m layout)
81− => Proxy layout -> Proxy m -> Dynamic t BaseUrl -> Client t m layout
82−client p q baseurl = clientWithRoute p q 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
141+
83142
84143-- | This class lets us define how each API combinator
85144-- influences the creation of an HTTP request. It's mostly
86145-- an internal class, you can just use 'client'.
87−class HasClient t m layout where
88− type Client t m layout :: *
89− clientWithRoute :: Proxy layout -> Proxy m -> Req t -> Dynamic t BaseUrl -> Client t m layout
90−
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
91175
92−instance (HasClient t m a, HasClient t m b) => HasClient t m (a :<|> b) where
93− type Client t m (a :<|> b) = Client t m a :<|> Client t m b
94− clientWithRoute Proxy q req baseurl =
95− clientWithRoute (Proxy :: Proxy a) q req baseurl :<|>
96− clientWithRoute (Proxy :: Proxy b) q req baseurl
97176
98177-- Capture. Example:
99178-- > type MyApi = "books" :> Capture "isbn" Text :> Get '[JSON] Book
@@ -103,67 +182,72 @@ instance (HasClient t m a, HasClient t m b) => HasClient t m (a :<|> b) where
103182-- > getBook :: SupportsServantReflex t m
104183-- => Dynamic t BaseUrl
105184-- -> Dynamic t (Maybe Text)
106−-- -> Event t ()
107−-- -> m (Event t (Either XhrError (Text, Book)))
185+-- -> Event t l
186+-- -> m (Event t (l, ReqResult Book))
108187-- > getBook = client myApi (constDyn host)
109−instance (SupportsServantReflex t m, ToHttpApiData a, HasClient t m sublayout)
110− => HasClient t m (Capture capture a :> sublayout) where
111188
112− type Client t m (Capture capture a :> sublayout) =
113− 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
114191
115− clientWithRoute Proxy q req baseurl val =
116− clientWithRoute (Proxy :: Proxy sublayout)
117− q
118− (prependToPathParts p req)
119− baseurl
192+ type Client t m (Capture capture a :> sublayout) tag =
193+ Dynamic t (Either Text a) -> Client t m sublayout tag
120194
195+ clientWithRouteAndResultHandler Proxy q t req baseurl opts wrap val =
196+ clientWithRouteAndResultHandler
197+ (Proxy :: Proxy sublayout) q t (prependToPathParts p req) baseurl opts wrap
121198 where p = (fmap . fmap) (toUrlPiece) val
122199
200+
123201-- VERB (Returning content) --
124202instance {-# OVERLAPPABLE #-}
125203 -- Note [Non-Empty Content Types]
126204 (MimeUnrender ct a, ReflectMethod method, cts' ~ (ct ': cts), SupportsServantReflex t m
127− ) => HasClient t m (Verb method status cts' a) where
128− type Client t m (Verb method status cts' a) =
129− 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))
130208 -- TODO how to access input types here?
131209 -- ExceptT ServantError IO a
132− clientWithRoute Proxy _ req baseurl =
133− performRequestCT (Proxy :: Proxy ct) method req' baseurl
210+ clientWithRouteAndResultHandler Proxy _ _ req baseurl opts wrap trigs =
211+ wrap =<< fmap runIdentity <$> performRequestsCT (Proxy :: Proxy ct) method (constDyn $ Identity $ req') baseurl opts trigs
134212 where method = E.decodeUtf8 $ reflectMethod (Proxy :: Proxy method)
135213 req' = req { reqMethod = method }
136214
215+
137216-- -- VERB (No content) --
138217instance {-# OVERLAPPING #-}
139218 (ReflectMethod method, SupportsServantReflex t m) =>
140− HasClient t m (Verb method status cts NoContent) where
141− type Client t m (Verb method status cts NoContent) =
142− 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))
143222 -- TODO: how to access input types here?
144223 -- ExceptT ServantError IO NoContent
145− clientWithRoute Proxy _ req baseurl =
146− performRequestNoBody method req baseurl
224+ clientWithRouteAndResultHandler Proxy _ _ req baseurl opts wrap trigs =
225+ wrap =<< fmap runIdentity <$> performRequestsNoBody method (constDyn $ Identity req) baseurl opts trigs
147226 where method = E.decodeUtf8 $ reflectMethod (Proxy :: Proxy method)
148227
149−toHeaders :: BuildHeadersTo ls => ReqResult a -> ReqResult (Headers ls a)
228+
229+toHeaders :: BuildHeadersTo ls => ReqResult tag a -> ReqResult tag (Headers ls a)
150230toHeaders r =
151− let toBS = E.encodeUtf8
152− hdrs = maybe []
153− (\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))
154233 (Map.toList $ _xhrResponse_headers xhr))
155234 (response r)
156235 in ffor r $ \a -> Headers {getResponse = a ,getHeadersHList = buildHeadersTo hdrs}
157236
237+
158238class BuildHeaderKeysTo hs where
159− buildHeaderKeysTo :: Proxy hs -> [T.Text]
239+ buildHeaderKeysTo :: Proxy hs -> [CI.CI T.Text]
160240
161241instance {-# OVERLAPPABLE #-} BuildHeaderKeysTo '[]
162242 where buildHeaderKeysTo _ = []
163243
164244instance {-# OVERLAPPABLE #-} (BuildHeaderKeysTo xs, KnownSymbol h)
165− => BuildHeaderKeysTo '[(Header h v) ': xs] where
166− 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+
167251
168252-- HEADERS Verb (Content) --
169253-- Headers combinator not treated in fully general case,
@@ -175,33 +259,35 @@ instance {-# OVERLAPPABLE #-}
175259 ( MimeUnrender ct a, BuildHeadersTo ls, BuildHeaderKeysTo ls,
176260 ReflectMethod method, cts' ~ (ct ': cts),
177261 SupportsServantReflex t m
178− ) => HasClient t m (Verb method status cts' (Headers ls a)) where
179− type Client t m (Verb method status cts' (Headers ls a)) =
180− Event t () -> m (Event t (ReqResult (Headers ls a)))
181− 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
182266 let method = E.decodeUtf8 $ reflectMethod (Proxy :: Proxy method)
183− resp <- performRequestCT (Proxy :: Proxy ct) method req' baseurl
184− return $ (fmap . fmap) toHeaders resp
267+ resp <- fmap runIdentity <$> performRequestsCT (Proxy :: Proxy ct) method (constDyn $ Identity req') baseurl opts trigs
268+ wrap $ toHeaders <$> resp
185269 where req' = req { respHeaders =
186270 OnlyHeaders (Set.fromList (buildHeaderKeysTo (Proxy :: Proxy ls)))
187271 }
188272
273+
189274-- HEADERS Verb (No content) --
190275instance {-# OVERLAPPABLE #-}
191276 ( BuildHeadersTo ls, BuildHeaderKeysTo ls, ReflectMethod method,
192277 SupportsServantReflex t m
193− ) => HasClient t m (Verb method status cts (Headers ls NoContent)) where
194− type Client t m (Verb method status cts (Headers ls NoContent))
195− = Event t () -> m (Event t (ReqResult (Headers ls NoContent)))
196− 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
197282 let method = E.decodeUtf8 $ reflectMethod (Proxy :: Proxy method)
198− resp <- performRequestNoBody method req' baseurl
199− return $ (fmap . fmap) toHeaders resp
283+ resp <- fmap runIdentity <$> performRequestsNoBody method (constDyn $ Identity req') baseurl opts trigs
284+ wrap $ toHeaders <$> resp
200285 where req' = req {respHeaders =
201286 OnlyHeaders (Set.fromList (buildHeaderKeysTo (Proxy :: Proxy ls)))
202287 }
203288
204289
290+
205291-- HEADER
206292-- > newtype Referer = Referer { referrer :: Text }
207293-- > deriving (Eq, Show, Generic, FromText, ToHttpApiData)
@@ -216,29 +302,45 @@ instance {-# OVERLAPPABLE #-}
216302-- > -- then you can just use "viewRefer" to query that endpoint
217303-- > -- specifying Nothing or e.g Just "http://haskell.org/" as arguments
218304instance (KnownSymbol sym, ToHttpApiData a,
219− HasClient t m sublayout, SupportsServantReflex t m)
220− => 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
221307
222− type Client t m (Header sym a :> sublayout) =
223− 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
224310
225− clientWithRoute Proxy q req baseurl eVal =
226− clientWithRoute (Proxy :: Proxy sublayout)
227− q
228− (Servant.Common.Req.addHeader hname eVal req)
229− 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
230316 where hname = T.pack $ symbolVal (Proxy :: Proxy sym)
231317
318+
319+
320+
232321-- | Using a 'HttpVersion' combinator in your API doesn't affect the client
233322-- functions.
234−instance HasClient t m sublayout
235− => 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)
236342
237− type Client t m (HttpVersion :> sublayout) =
238− Client t m sublayout
239343
240− clientWithRoute Proxy q =
241− clientWithRoute (Proxy :: Proxy sublayout) q
242344
243345
244346-- | If you use a 'QueryParam' in one of your endpoints in your API,
@@ -267,16 +369,16 @@ instance HasClient t m sublayout
267369-- > -- then you can just use "getBooksBy" to query that endpoint.
268370-- > -- 'getBooksBy Nothing' for all books
269371-- > -- 'getBooksBy (Just "Isaac Asimov")' to get all books by Isaac Asimov
270−instance (KnownSymbol sym, ToHttpApiData a, HasClient t m sublayout, Reflex t)
271− => 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
272374
273− type Client t m (QueryParam sym a :> sublayout) =
274− 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
275377
276378 -- if mparam = Nothing, we don't add it to the query string
277− clientWithRoute Proxy q req baseurl mparam =
278− clientWithRoute (Proxy :: Proxy sublayout) q
279− (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
280382
281383 where pname = symbolVal (Proxy :: Proxy sym)
282384 --p prm = QueryPartParam $ (fmap . fmap) (toQueryParam) prm
@@ -284,6 +386,8 @@ instance (KnownSymbol sym, ToHttpApiData a, HasClient t m sublayout, Reflex t)
284386 p prm = QueryPartParam $ fmap qParamToQueryPart prm -- (fmap . fmap) (unpack . toQueryParam) prm
285387 paramPair = (T.pack pname, p mparam)
286388
389+
390+
287391-- | If you use a 'QueryParams' in one of your endpoints in your API,
288392-- the corresponding querying function will automatically take
289393-- an additional argument, a list of values of the type specified
@@ -312,21 +416,22 @@ instance (KnownSymbol sym, ToHttpApiData a, HasClient t m sublayout, Reflex t)
312416-- > -- 'getBooksBy []' for all books
313417-- > -- 'getBooksBy ["Isaac Asimov", "Robert A. Heinlein"]'
314418-- > -- to get all books by Asimov and Heinlein
315−instance (KnownSymbol sym, ToHttpApiData a, HasClient t m sublayout, Reflex t)
316− => 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
317421
318− type Client t m (QueryParams sym a :> sublayout) =
319− 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
320424
321− clientWithRoute Proxy q req baseurl paramlist =
322− 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
323427
324428 where req' = req { qParams = (T.pack pname, params') : qParams req }
325429 pname = symbolVal (Proxy :: Proxy sym)
326− params' = QueryPartParams $ (fmap . fmap) (toQueryParam)
430+ params' = QueryPartParams $ (fmap . fmap) toQueryParam
327431 paramlist
328432
329433
434+
330435-- | If you use a 'QueryFlag' in one of your endpoints in your API,
331436-- the corresponding querying function will automatically take
332437-- an additional 'Bool' argument.
@@ -351,49 +456,42 @@ instance (KnownSymbol sym, ToHttpApiData a, HasClient t m sublayout, Reflex t)
351456-- > -- 'getBooksBy True' to only get _already published_ books
352457
353458-- TODO Bring back
354−instance (KnownSymbol sym, HasClient t m sublayout, Reflex t)
355− => 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
356461
357− type Client t m (QueryFlag sym :> sublayout) =
358− 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
359464
360− clientWithRoute Proxy q req baseurl flag =
361− 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
362467
363468 where req' = req { qParams = thisPair : qParams req }
364469 thisPair = (T.pack pName, QueryPartFlag flag) :: (Text, QueryPart t)
365470 pName = symbolVal (Proxy :: Proxy sym)
366471
367472
368−-- | Pick a 'Method' and specify where the server you want to query is. You get
369−-- back the full `Response`.
370−-- TODO redo
371−instance SupportsServantReflex t m => HasClient t m Raw where
372− type Client t m Raw = Dynamic t (Either Text (XhrRequest ()))
373− -> Event t ()
374− -> m (Event t (ReqResult ()))
375−
376− -- clientWithRoute :: Proxy Raw -> Proxy m -> Req -> BaseUrl -> Client t m Raw
377− clientWithRoute _ _ _ baseurl xhrs triggers = do
378− let xhrs' = liftA2 (\x path -> case x of
379− Left e -> Left e
380− Right jx -> Right $ jx {_xhrRequest_url = path
381− <> _xhrRequest_url jx})
382− xhrs
383− (showBaseUrl <$> baseurl)
384− reqs = tagPromptlyDyn xhrs' triggers
385− okReq = fmapMaybe hush reqs
386− badReq = fmapMaybe tattle reqs
387− resps <- performRequestAsync okReq
388− return $ leftmost [fmap (ResponseSuccess () ) resps
389− ,fmap RequestFailure badReq]
390−
391−
392−hush :: Either e a -> Maybe a
393−hush = either (const Nothing) Just
394−
395−tattle :: Either e a -> Maybe e
396−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+
397495
398496-- | If you use a 'ReqBody' in one of your endpoints in your API,
399497-- the corresponding querying function will automatically take
@@ -415,14 +513,14 @@ tattle = either Just (const Nothing)
415513-- > where host = BaseUrl Http "localhost" 8080
416514-- > -- then you can just use "addBook" to query that endpoint
417515
418−instance (MimeRender ct a, HasClient t m sublayout, Reflex t)
419− => 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
420518
421− type Client t m (ReqBody (ct ': cts) a :> sublayout) =
422− 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
423521
424− clientWithRoute Proxy q req baseurl body =
425− 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
426524 where req' = req { reqBody = bodyBytesCT }
427525 ctProxy = Proxy :: Proxy ct
428526 ctString = T.pack $ show $ contentType ctProxy
@@ -430,43 +528,49 @@ instance (MimeRender ct a, HasClient t m sublayout, Reflex t)
430528 (\b -> (mimeRender ctProxy b, ctString))
431529 body
432530
531+
532+
433533-- | Make the querying function append @path@ to the request path.
434−instance (KnownSymbol path, HasClient t m sublayout, Reflex t) => HasClient t m (path :> sublayout) where
435− 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
436536
437− clientWithRoute Proxy q req baseurl =
438− clientWithRoute (Proxy :: Proxy sublayout) q
439− (prependToPathParts (pure (Right $ T.pack p)) req)
440− 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
441540
442541 where p = symbolVal (Proxy :: Proxy path)
443542
444−instance HasClient t m api => HasClient t m (Vault :> api) where
445− type Client t m (Vault :> api) = Client t m api
446543
447− clientWithRoute Proxy q req baseurl =
448− clientWithRoute (Proxy :: Proxy api) q req baseurl
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+
449550
450−instance HasClient t m api => HasClient t m (RemoteHost :> api) where
451− type Client t m (RemoteHost :> api) = Client t m api
551+instance HasClient t m api tag => HasClient t m (RemoteHost :> api) tag where
552+ type Client t m (RemoteHost :> api) tag = Client t m api tag
452553
453− clientWithRoute Proxy q req baseurl =
454− clientWithRoute (Proxy :: Proxy api) q req baseurl
554+ clientWithRouteAndResultHandler Proxy =
555+ clientWithRouteAndResultHandler (Proxy :: Proxy api)
455556
456−instance HasClient t m api => HasClient t m (IsSecure :> api) where
457− type Client t m (IsSecure :> api) = Client t m api
458557
459− clientWithRoute Proxy q req baseurl =
460− clientWithRoute (Proxy :: Proxy api) q req baseurl
461558
462−instance (HasClient t m api, Reflex t)
463− => HasClient t m (BasicAuth realm usr :> api) where
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
464561
465− type Client t m (BasicAuth realm usr :> api) = Dynamic t (Maybe BasicAuthData)
466− -> Client t m api
562+ clientWithRouteAndResultHandler Proxy =
563+ clientWithRouteAndResultHandler (Proxy :: Proxy api)
467564
468− clientWithRoute Proxy q req baseurl authdata =
469− clientWithRoute (Proxy :: Proxy api) q req' baseurl
565+
566+instance (HasClient t m api tag, Reflex t)
567+ => HasClient t m (BasicAuth realm usr :> api) tag where
568+
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
470574 where
471575 req' = req { authData = Just authdata }
472576
@@ -492,3 +596,29 @@ non-empty lists, but is otherwise more specific, no instance will be overall
492596more specific. This in turn generally means adding yet another instance (one
493597for empty and one for non-empty lists).
494598-}
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