@@ -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,48 +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)
46−import Servant.Common.BaseUrl (BaseUrl, baseUrlWidget, showBaseUrl,
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,
4775 SupportsServantReflex)
48−import Servant.Common.Req (Req, ReqResult(..), QParam(..),
76+import Servant.Common.Req (ClientOptions(..),
77+ defaultClientOptions,
78+ Req, ReqResult(..), QParam(..),
4979 QueryPart(..), addHeader, authData,
50− defReq, prependToPathParts,
51− performRequestCT,
52− performRequestNoBody,
80+ defReq, evalResponse, prependToPathParts,
81+ -- performRequestCT,
82+ performRequestsCT,
83+ -- performRequestNoBody,
84+ performRequestsNoBody,
85+ performSomeRequestsAsync,
5386 qParamToQueryPart, reqBody,
5487 reqSuccess, reqFailure,
55− reqMethod, respHeaders, response,
56− qParams)
57−import Reflex.Dom (Dynamic, Event, Reflex,
58− XhrRequest(..),
59− XhrResponseHeaders(..),
60− XhrResponse(..), ffor, fmapMaybe,
61− leftmost, performRequestAsync,
62− tagPromptlyDyn )
88+ reqMethod, respHeaders,
89+ response,
90+ reqTag,
91+ qParams, withCredentials)
92+
6393
6494-- * Accessing APIs as a Client
6595
@@ -71,28 +101,78 @@ import Reflex.Dom (Dynamic, Event, Reflex,
71101-- > myApi :: Proxy MyApi
72102-- > myApi = Proxy
73103-- >
74−-- > getAllBooks :: Event t () -> m (Event t (Either XhrError ((),[Book])))
75−-- > postNewBook :: Dynamic t (Maybe Book) -> Event t ()
76−-- -> 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)))
77107-- > (getAllBooks :<|> postNewBook) = client myApi host
78108-- > where host = constDyn $ BaseUrl Http "localhost" 8080
79−client :: (HasClient t m layout)
80− => Proxy layout -> Proxy m -> Dynamic t BaseUrl -> Client t m layout
81−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+
82142
83143-- | This class lets us define how each API combinator
84144-- influences the creation of an HTTP request. It's mostly
85145-- an internal class, you can just use 'client'.
86−class HasClient t m layout where
87− type Client t m layout :: *
88− clientWithRoute :: Proxy layout -> Proxy m -> Req t -> Dynamic t BaseUrl -> Client t m layout
89−
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
90175
91−instance (HasClient t m a, HasClient t m b) => HasClient t m (a :<|> b) where
92− type Client t m (a :<|> b) = Client t m a :<|> Client t m b
93− clientWithRoute Proxy q req baseurl =
94− clientWithRoute (Proxy :: Proxy a) q req baseurl :<|>
95− clientWithRoute (Proxy :: Proxy b) q req baseurl
96176
97177-- Capture. Example:
98178-- > type MyApi = "books" :> Capture "isbn" Text :> Get '[JSON] Book
@@ -102,67 +182,72 @@ instance (HasClient t m a, HasClient t m b) => HasClient t m (a :<|> b) where
102182-- > getBook :: SupportsServantReflex t m
103183-- => Dynamic t BaseUrl
104184-- -> Dynamic t (Maybe Text)
105−-- -> Event t ()
106−-- -> m (Event t (Either XhrError (Text, Book)))
185+-- -> Event t l
186+-- -> m (Event t (l, ReqResult Book))
107187-- > getBook = client myApi (constDyn host)
108−instance (SupportsServantReflex t m, ToHttpApiData a, HasClient t m sublayout)
109− => HasClient t m (Capture capture a :> sublayout) where
110188
111− type Client t m (Capture capture a :> sublayout) =
112− 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
113191
114− clientWithRoute Proxy q req baseurl val =
115− clientWithRoute (Proxy :: Proxy sublayout)
116− q
117− (prependToPathParts p req)
118− baseurl
192+ type Client t m (Capture capture a :> sublayout) tag =
193+ Dynamic t (Either Text a) -> Client t m sublayout tag
119194
195+ clientWithRouteAndResultHandler Proxy q t req baseurl opts wrap val =
196+ clientWithRouteAndResultHandler
197+ (Proxy :: Proxy sublayout) q t (prependToPathParts p req) baseurl opts wrap
120198 where p = (fmap . fmap) (toUrlPiece) val
121199
200+
122201-- VERB (Returning content) --
123202instance {-# OVERLAPPABLE #-}
124203 -- Note [Non-Empty Content Types]
125204 (MimeUnrender ct a, ReflectMethod method, cts' ~ (ct ': cts), SupportsServantReflex t m
126− ) => HasClient t m (Verb method status cts' a) where
127− type Client t m (Verb method status cts' a) =
128− 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))
129208 -- TODO how to access input types here?
130209 -- ExceptT ServantError IO a
131− clientWithRoute Proxy _ req baseurl =
132− 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
133212 where method = E.decodeUtf8 $ reflectMethod (Proxy :: Proxy method)
134213 req' = req { reqMethod = method }
135214
215+
136216-- -- VERB (No content) --
137217instance {-# OVERLAPPING #-}
138218 (ReflectMethod method, SupportsServantReflex t m) =>
139− HasClient t m (Verb method status cts NoContent) where
140− type Client t m (Verb method status cts NoContent) =
141− 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))
142222 -- TODO: how to access input types here?
143223 -- ExceptT ServantError IO NoContent
144− clientWithRoute Proxy _ req baseurl =
145− performRequestNoBody method req baseurl
224+ clientWithRouteAndResultHandler Proxy _ _ req baseurl opts wrap trigs =
225+ wrap =<< fmap runIdentity <$> performRequestsNoBody method (constDyn $ Identity req) baseurl opts trigs
146226 where method = E.decodeUtf8 $ reflectMethod (Proxy :: Proxy method)
147227
148−toHeaders :: BuildHeadersTo ls => ReqResult a -> ReqResult (Headers ls a)
228+
229+toHeaders :: BuildHeadersTo ls => ReqResult tag a -> ReqResult tag (Headers ls a)
149230toHeaders r =
150− let toBS = E.encodeUtf8
151− hdrs = maybe []
152− (\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))
153233 (Map.toList $ _xhrResponse_headers xhr))
154234 (response r)
155235 in ffor r $ \a -> Headers {getResponse = a ,getHeadersHList = buildHeadersTo hdrs}
156236
237+
157238class BuildHeaderKeysTo hs where
158− buildHeaderKeysTo :: Proxy hs -> [T.Text]
239+ buildHeaderKeysTo :: Proxy hs -> [CI.CI T.Text]
159240
160241instance {-# OVERLAPPABLE #-} BuildHeaderKeysTo '[]
161242 where buildHeaderKeysTo _ = []
162243
163244instance {-# OVERLAPPABLE #-} (BuildHeaderKeysTo xs, KnownSymbol h)
164− => BuildHeaderKeysTo '[(Header h v) ': xs] where
165− 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+
166251
167252-- HEADERS Verb (Content) --
168253-- Headers combinator not treated in fully general case,
@@ -174,33 +259,35 @@ instance {-# OVERLAPPABLE #-}
174259 ( MimeUnrender ct a, BuildHeadersTo ls, BuildHeaderKeysTo ls,
175260 ReflectMethod method, cts' ~ (ct ': cts),
176261 SupportsServantReflex t m
177− ) => HasClient t m (Verb method status cts' (Headers ls a)) where
178− type Client t m (Verb method status cts' (Headers ls a)) =
179− Event t () -> m (Event t (ReqResult (Headers ls a)))
180− 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
181266 let method = E.decodeUtf8 $ reflectMethod (Proxy :: Proxy method)
182− resp <- performRequestCT (Proxy :: Proxy ct) method req' baseurl
183− return $ (fmap . fmap) toHeaders resp
267+ resp <- fmap runIdentity <$> performRequestsCT (Proxy :: Proxy ct) method (constDyn $ Identity req') baseurl opts trigs
268+ wrap $ toHeaders <$> resp
184269 where req' = req { respHeaders =
185270 OnlyHeaders (Set.fromList (buildHeaderKeysTo (Proxy :: Proxy ls)))
186271 }
187272
273+
188274-- HEADERS Verb (No content) --
189275instance {-# OVERLAPPABLE #-}
190276 ( BuildHeadersTo ls, BuildHeaderKeysTo ls, ReflectMethod method,
191277 SupportsServantReflex t m
192− ) => HasClient t m (Verb method status cts (Headers ls NoContent)) where
193− type Client t m (Verb method status cts (Headers ls NoContent))
194− = Event t () -> m (Event t (ReqResult (Headers ls NoContent)))
195− 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
196282 let method = E.decodeUtf8 $ reflectMethod (Proxy :: Proxy method)
197− resp <- performRequestNoBody method req' baseurl
198− return $ (fmap . fmap) toHeaders resp
283+ resp <- fmap runIdentity <$> performRequestsNoBody method (constDyn $ Identity req') baseurl opts trigs
284+ wrap $ toHeaders <$> resp
199285 where req' = req {respHeaders =
200286 OnlyHeaders (Set.fromList (buildHeaderKeysTo (Proxy :: Proxy ls)))
201287 }
202288
203289
290+
204291-- HEADER
205292-- > newtype Referer = Referer { referrer :: Text }
206293-- > deriving (Eq, Show, Generic, FromText, ToHttpApiData)
@@ -215,29 +302,45 @@ instance {-# OVERLAPPABLE #-}
215302-- > -- then you can just use "viewRefer" to query that endpoint
216303-- > -- specifying Nothing or e.g Just "http://haskell.org/" as arguments
217304instance (KnownSymbol sym, ToHttpApiData a,
218− HasClient t m sublayout, SupportsServantReflex t m)
219− => 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
220307
221− type Client t m (Header sym a :> sublayout) =
222− 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
223310
224− clientWithRoute Proxy q req baseurl eVal =
225− clientWithRoute (Proxy :: Proxy sublayout)
226− q
227− (Servant.Common.Req.addHeader hname eVal req)
228− 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
229316 where hname = T.pack $ symbolVal (Proxy :: Proxy sym)
230317
318+
319+
320+
231321-- | Using a 'HttpVersion' combinator in your API doesn't affect the client
232322-- functions.
233−instance HasClient t m sublayout
234− => 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)
235342
236− type Client t m (HttpVersion :> sublayout) =
237− Client t m sublayout
238343
239− clientWithRoute Proxy q =
240− clientWithRoute (Proxy :: Proxy sublayout) q
241344
242345
243346-- | If you use a 'QueryParam' in one of your endpoints in your API,
@@ -266,16 +369,16 @@ instance HasClient t m sublayout
266369-- > -- then you can just use "getBooksBy" to query that endpoint.
267370-- > -- 'getBooksBy Nothing' for all books
268371-- > -- 'getBooksBy (Just "Isaac Asimov")' to get all books by Isaac Asimov
269−instance (KnownSymbol sym, ToHttpApiData a, HasClient t m sublayout, Reflex t)
270− => 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
271374
272− type Client t m (QueryParam sym a :> sublayout) =
273− 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
274377
275378 -- if mparam = Nothing, we don't add it to the query string
276− clientWithRoute Proxy q req baseurl mparam =
277− clientWithRoute (Proxy :: Proxy sublayout) q
278− (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
279382
280383 where pname = symbolVal (Proxy :: Proxy sym)
281384 --p prm = QueryPartParam $ (fmap . fmap) (toQueryParam) prm
@@ -283,6 +386,8 @@ instance (KnownSymbol sym, ToHttpApiData a, HasClient t m sublayout, Reflex t)
283386 p prm = QueryPartParam $ fmap qParamToQueryPart prm -- (fmap . fmap) (unpack . toQueryParam) prm
284387 paramPair = (T.pack pname, p mparam)
285388
389+
390+
286391-- | If you use a 'QueryParams' in one of your endpoints in your API,
287392-- the corresponding querying function will automatically take
288393-- an additional argument, a list of values of the type specified
@@ -311,21 +416,22 @@ instance (KnownSymbol sym, ToHttpApiData a, HasClient t m sublayout, Reflex t)
311416-- > -- 'getBooksBy []' for all books
312417-- > -- 'getBooksBy ["Isaac Asimov", "Robert A. Heinlein"]'
313418-- > -- to get all books by Asimov and Heinlein
314−instance (KnownSymbol sym, ToHttpApiData a, HasClient t m sublayout, Reflex t)
315− => 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
316421
317− type Client t m (QueryParams sym a :> sublayout) =
318− 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
319424
320− clientWithRoute Proxy q req baseurl paramlist =
321− 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
322427
323428 where req' = req { qParams = (T.pack pname, params') : qParams req }
324429 pname = symbolVal (Proxy :: Proxy sym)
325− params' = QueryPartParams $ (fmap . fmap) (toQueryParam)
430+ params' = QueryPartParams $ (fmap . fmap) toQueryParam
326431 paramlist
327432
328433
434+
329435-- | If you use a 'QueryFlag' in one of your endpoints in your API,
330436-- the corresponding querying function will automatically take
331437-- an additional 'Bool' argument.
@@ -350,49 +456,42 @@ instance (KnownSymbol sym, ToHttpApiData a, HasClient t m sublayout, Reflex t)
350456-- > -- 'getBooksBy True' to only get _already published_ books
351457
352458-- TODO Bring back
353−instance (KnownSymbol sym, HasClient t m sublayout, Reflex t)
354− => 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
355461
356− type Client t m (QueryFlag sym :> sublayout) =
357− 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
358464
359− clientWithRoute Proxy q req baseurl flag =
360− 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
361467
362468 where req' = req { qParams = thisPair : qParams req }
363469 thisPair = (T.pack pName, QueryPartFlag flag) :: (Text, QueryPart t)
364470 pName = symbolVal (Proxy :: Proxy sym)
365471
366472
367−-- | Pick a 'Method' and specify where the server you want to query is. You get
368−-- back the full `Response`.
369−-- TODO redo
370−instance SupportsServantReflex t m => HasClient t m Raw where
371− type Client t m Raw = Dynamic t (Either Text (XhrRequest ()))
372− -> Event t ()
373− -> m (Event t (ReqResult ()))
374−
375− -- clientWithRoute :: Proxy Raw -> Proxy m -> Req -> BaseUrl -> Client t m Raw
376− clientWithRoute _ _ _ baseurl xhrs triggers = do
377− let xhrs' = liftA2 (\x path -> case x of
378− Left e -> Left e
379− Right jx -> Right $ jx {_xhrRequest_url = path
380− <> _xhrRequest_url jx})
381− xhrs
382− (showBaseUrl <$> baseurl)
383− reqs = tagPromptlyDyn xhrs' triggers
384− okReq = fmapMaybe hush reqs
385− badReq = fmapMaybe tattle reqs
386− resps <- performRequestAsync okReq
387− return $ leftmost [fmap (ResponseSuccess () ) resps
388− ,fmap RequestFailure badReq]
389−
390−
391−hush :: Either e a -> Maybe a
392−hush = either (const Nothing) Just
393−
394−tattle :: Either e a -> Maybe e
395−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+
396495
397496-- | If you use a 'ReqBody' in one of your endpoints in your API,
398497-- the corresponding querying function will automatically take
@@ -414,14 +513,14 @@ tattle = either Just (const Nothing)
414513-- > where host = BaseUrl Http "localhost" 8080
415514-- > -- then you can just use "addBook" to query that endpoint
416515
417−instance (MimeRender ct a, HasClient t m sublayout, Reflex t)
418− => 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
419518
420− type Client t m (ReqBody (ct ': cts) a :> sublayout) =
421− 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
422521
423− clientWithRoute Proxy q req baseurl body =
424− 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
425524 where req' = req { reqBody = bodyBytesCT }
426525 ctProxy = Proxy :: Proxy ct
427526 ctString = T.pack $ show $ contentType ctProxy
@@ -429,43 +528,49 @@ instance (MimeRender ct a, HasClient t m sublayout, Reflex t)
429528 (\b -> (mimeRender ctProxy b, ctString))
430529 body
431530
531+
532+
432533-- | Make the querying function append @path@ to the request path.
433−instance (KnownSymbol path, HasClient t m sublayout, Reflex t) => HasClient t m (path :> sublayout) where
434− 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
435536
436− clientWithRoute Proxy q req baseurl =
437− clientWithRoute (Proxy :: Proxy sublayout) q
438− (prependToPathParts (pure (Right $ T.pack p)) req)
439− 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
440540
441541 where p = symbolVal (Proxy :: Proxy path)
442542
443−instance HasClient t m api => HasClient t m (Vault :> api) where
444− type Client t m (Vault :> api) = Client t m api
445543
446− clientWithRoute Proxy q req baseurl =
447− 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+
448550
449−instance HasClient t m api => HasClient t m (RemoteHost :> api) where
450− 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
451553
452− clientWithRoute Proxy q req baseurl =
453− clientWithRoute (Proxy :: Proxy api) q req baseurl
554+ clientWithRouteAndResultHandler Proxy =
555+ clientWithRouteAndResultHandler (Proxy :: Proxy api)
454556
455−instance HasClient t m api => HasClient t m (IsSecure :> api) where
456− type Client t m (IsSecure :> api) = Client t m api
457557
458− clientWithRoute Proxy q req baseurl =
459− clientWithRoute (Proxy :: Proxy api) q req baseurl
460558
461−instance (HasClient t m api, Reflex t)
462− => 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
463561
464− type Client t m (BasicAuth realm usr :> api) = Dynamic t (Maybe BasicAuthData)
465− -> Client t m api
562+ clientWithRouteAndResultHandler Proxy =
563+ clientWithRouteAndResultHandler (Proxy :: Proxy api)
466564
467− clientWithRoute Proxy q req baseurl authdata =
468− 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
469574 where
470575 req' = req { authData = Just authdata }
471576
@@ -491,3 +596,29 @@ non-empty lists, but is otherwise more specific, no instance will be overall
491596more specific. This in turn generally means adding yet another instance (one
492597for empty and one for non-empty lists).
493598-}
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