@@ -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,27 +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
40+------------------------------------------------------------------------------
2641import Control.Applicative
27−import qualified Data.Set as Set
28−import qualified Data.Text.Encoding as E
29−import Data.CaseInsensitive (mk)
30−import Data.Proxy
31−import Data.String.Conversions
42+import qualified Data.CaseInsensitive as CI
43+import Data.Functor.Identity
3244import qualified Data.Map as Map
45+import Data.Monoid ((<>))
46+import Data.Proxy (Proxy (..))
47+import qualified Data.Set as Set
3348import Data.Text (Text)
3449import qualified Data.Text as T
35−import Data.Text.Encoding
36−import GHC.TypeLits
37−import Servant.API
38−import Servant.Common.BaseUrl
39−import Servant.Common.Req
40−import Reflex
41−import Reflex.Dom
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+
4293
4394-- * Accessing APIs as a Client
4495
@@ -50,98 +101,153 @@ import Reflex.Dom
50101-- > myApi :: Proxy MyApi
51102-- > myApi = Proxy
52103-- >
53−-- > getAllBooks :: Event t () -> m (Event t (Either XhrError ((),[Book])))
54−-- > postNewBook :: Dynamic t (Maybe Book) -> Event t ()
55−-- -> 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)))
56107-- > (getAllBooks :<|> postNewBook) = client myApi host
57108-- > where host = constDyn $ BaseUrl Http "localhost" 8080
58−client :: (HasClient t m layout)
59− => Proxy layout -> Proxy m -> Dynamic t BaseUrl -> Client t m layout
60−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+
61142
62143-- | This class lets us define how each API combinator
63144-- influences the creation of an HTTP request. It's mostly
64145-- an internal class, you can just use 'client'.
65−class HasClient t m layout where
66− type Client t m layout :: *
67− clientWithRoute :: Proxy layout -> Proxy m -> Req t -> Dynamic t BaseUrl -> Client t m layout
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
68175
69176
70−instance (HasClient t m a, HasClient t m b) => HasClient t m (a :<|> b) where
71− type Client t m (a :<|> b) = Client t m a :<|> Client t m b
72− clientWithRoute Proxy q req baseurl =
73− clientWithRoute (Proxy :: Proxy a) q req baseurl :<|>
74− clientWithRoute (Proxy :: Proxy b) q req baseurl
75−
76177-- Capture. Example:
77178-- > type MyApi = "books" :> Capture "isbn" Text :> Get '[JSON] Book
78179-- >
79180-- > myApi :: Proxy MyApi = Proxy
80181-- >
81−-- > getBook :: MonadWidget t m
182+-- > getBook :: SupportsServantReflex t m
82183-- => Dynamic t BaseUrl
83184-- -> Dynamic t (Maybe Text)
84−-- -> Event t ()
85−-- -> m (Event t (Either XhrError (Text, Book)))
185+-- -> Event t l
186+-- -> m (Event t (l, ReqResult Book))
86187-- > getBook = client myApi (constDyn host)
87−instance (MonadWidget t m, ToHttpApiData a, HasClient t m sublayout)
88− => HasClient t m (Capture capture a :> sublayout) where
89188
90− type Client t m (Capture capture a :> sublayout) =
91− 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
92191
93− clientWithRoute Proxy q req baseurl val =
94− clientWithRoute (Proxy :: Proxy sublayout)
95− q
96− (prependToPathParts p req)
97− baseurl
192+ type Client t m (Capture capture a :> sublayout) tag =
193+ Dynamic t (Either Text a) -> Client t m sublayout tag
98194
195+ clientWithRouteAndResultHandler Proxy q t req baseurl opts wrap val =
196+ clientWithRouteAndResultHandler
197+ (Proxy :: Proxy sublayout) q t (prependToPathParts p req) baseurl opts wrap
99198 where p = (fmap . fmap) (toUrlPiece) val
100199
200+
101201-- VERB (Returning content) --
102202instance {-# OVERLAPPABLE #-}
103203 -- Note [Non-Empty Content Types]
104− (MimeUnrender ct a, ReflectMethod method, cts' ~ (ct ': cts), MonadWidget t m
105− ) => HasClient t m (Verb method status cts' a) where
106− type Client t m (Verb method status cts' a) =
107− Event t () -> m (Event t (ReqResult a))
204+ (MimeUnrender ct a, ReflectMethod method, cts' ~ (ct ': cts), SupportsServantReflex t m
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))
108208 -- TODO how to access input types here?
109209 -- ExceptT ServantError IO a
110− clientWithRoute Proxy _ req baseurl =
111− performRequestCT (Proxy :: Proxy ct) method req' baseurl
112− where method = decodeUtf8 $ reflectMethod (Proxy :: Proxy method)
210+ clientWithRouteAndResultHandler Proxy _ _ req baseurl opts wrap trigs =
211+ wrap =<< fmap runIdentity <$> performRequestsCT (Proxy :: Proxy ct) method (constDyn $ Identity $ req') baseurl opts trigs
212+ where method = E.decodeUtf8 $ reflectMethod (Proxy :: Proxy method)
113213 req' = req { reqMethod = method }
114214
215+
115216-- -- VERB (No content) --
116217instance {-# OVERLAPPING #-}
117− (ReflectMethod method, MonadWidget t m) =>
118− HasClient t m (Verb method status cts NoContent) where
119− type Client t m (Verb method status cts NoContent) =
120− Event t () -> m (Event t (ReqResult NoContent))
218+ (ReflectMethod method, SupportsServantReflex t m) =>
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))
121222 -- TODO: how to access input types here?
122223 -- ExceptT ServantError IO NoContent
123− clientWithRoute Proxy _ req baseurl =
124− performRequestNoBody method req baseurl
125− where method = decodeUtf8 $ reflectMethod (Proxy :: Proxy method)
224+ clientWithRouteAndResultHandler Proxy _ _ req baseurl opts wrap trigs =
225+ wrap =<< fmap runIdentity <$> performRequestsNoBody method (constDyn $ Identity req) baseurl opts trigs
226+ where method = E.decodeUtf8 $ reflectMethod (Proxy :: Proxy method)
126227
127−toHeaders :: BuildHeadersTo ls => ReqResult a -> ReqResult (Headers ls a)
228+
229+toHeaders :: BuildHeadersTo ls => ReqResult tag a -> ReqResult tag (Headers ls a)
128230toHeaders r =
129− let toBS = E.encodeUtf8
130− hdrs = maybe []
131− (\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))
132233 (Map.toList $ _xhrResponse_headers xhr))
133234 (response r)
134235 in ffor r $ \a -> Headers {getResponse = a ,getHeadersHList = buildHeadersTo hdrs}
135236
237+
136238class BuildHeaderKeysTo hs where
137− buildHeaderKeysTo :: Proxy hs -> [T.Text]
239+ buildHeaderKeysTo :: Proxy hs -> [CI.CI T.Text]
138240
139241instance {-# OVERLAPPABLE #-} BuildHeaderKeysTo '[]
140242 where buildHeaderKeysTo _ = []
141243
142244instance {-# OVERLAPPABLE #-} (BuildHeaderKeysTo xs, KnownSymbol h)
143− => BuildHeaderKeysTo '[(Header h v) ': xs] where
144− 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+
145251
146252-- HEADERS Verb (Content) --
147253-- Headers combinator not treated in fully general case,
@@ -152,34 +258,36 @@ instance {-# OVERLAPPABLE #-}
152258 -- Note [Non-Empty Content Types]
153259 ( MimeUnrender ct a, BuildHeadersTo ls, BuildHeaderKeysTo ls,
154260 ReflectMethod method, cts' ~ (ct ': cts),
155− MonadWidget t m
156− ) => HasClient t m (Verb method status cts' (Headers ls a)) where
157− type Client t m (Verb method status cts' (Headers ls a)) =
158− Event t () -> m (Event t (ReqResult (Headers ls a)))
159− clientWithRoute Proxy _ req baseurl = do
261+ SupportsServantReflex t m
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
160266 let method = E.decodeUtf8 $ reflectMethod (Proxy :: Proxy method)
161− resp <- performRequestCT (Proxy :: Proxy ct) method req' baseurl
162− return $ (fmap . fmap) toHeaders resp
267+ resp <- fmap runIdentity <$> performRequestsCT (Proxy :: Proxy ct) method (constDyn $ Identity req') baseurl opts trigs
268+ wrap $ toHeaders <$> resp
163269 where req' = req { respHeaders =
164270 OnlyHeaders (Set.fromList (buildHeaderKeysTo (Proxy :: Proxy ls)))
165271 }
166272
273+
167274-- HEADERS Verb (No content) --
168275instance {-# OVERLAPPABLE #-}
169276 ( BuildHeadersTo ls, BuildHeaderKeysTo ls, ReflectMethod method,
170− MonadWidget t m
171− ) => HasClient t m (Verb method status cts (Headers ls NoContent)) where
172− type Client t m (Verb method status cts (Headers ls NoContent))
173− = Event t () -> m (Event t (ReqResult (Headers ls NoContent)))
174− clientWithRoute Proxy _ req baseurl = do
277+ SupportsServantReflex t m
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
175282 let method = E.decodeUtf8 $ reflectMethod (Proxy :: Proxy method)
176− resp <- performRequestNoBody method req' baseurl
177− return $ (fmap . fmap) toHeaders resp
283+ resp <- fmap runIdentity <$> performRequestsNoBody method (constDyn $ Identity req') baseurl opts trigs
284+ wrap $ toHeaders <$> resp
178285 where req' = req {respHeaders =
179286 OnlyHeaders (Set.fromList (buildHeaderKeysTo (Proxy :: Proxy ls)))
180287 }
181288
182289
290+
183291-- HEADER
184292-- > newtype Referer = Referer { referrer :: Text }
185293-- > deriving (Eq, Show, Generic, FromText, ToHttpApiData)
@@ -194,29 +302,45 @@ instance {-# OVERLAPPABLE #-}
194302-- > -- then you can just use "viewRefer" to query that endpoint
195303-- > -- specifying Nothing or e.g Just "http://haskell.org/" as arguments
196304instance (KnownSymbol sym, ToHttpApiData a,
197− HasClient t m sublayout, MonadWidget t m)
198− => 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
199307
200− type Client t m (Header sym a :> sublayout) =
201− 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
202310
203− clientWithRoute Proxy q req baseurl eVal =
204− clientWithRoute (Proxy :: Proxy sublayout)
205− q
206− (Servant.Common.Req.addHeader hname eVal req)
207− 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
208316 where hname = T.pack $ symbolVal (Proxy :: Proxy sym)
209317
318+
319+
320+
210321-- | Using a 'HttpVersion' combinator in your API doesn't affect the client
211322-- functions.
212−instance HasClient t m sublayout
213− => 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)
214342
215− type Client t m (HttpVersion :> sublayout) =
216− Client t m sublayout
217343
218− clientWithRoute Proxy q =
219− clientWithRoute (Proxy :: Proxy sublayout) q
220344
221345
222346-- | If you use a 'QueryParam' in one of your endpoints in your API,
@@ -245,16 +369,16 @@ instance HasClient t m sublayout
245369-- > -- then you can just use "getBooksBy" to query that endpoint.
246370-- > -- 'getBooksBy Nothing' for all books
247371-- > -- 'getBooksBy (Just "Isaac Asimov")' to get all books by Isaac Asimov
248−instance (KnownSymbol sym, ToHttpApiData a, HasClient t m sublayout, Reflex t)
249− => 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
250374
251− type Client t m (QueryParam sym a :> sublayout) =
252− 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
253377
254378 -- if mparam = Nothing, we don't add it to the query string
255− clientWithRoute Proxy q req baseurl mparam =
256− clientWithRoute (Proxy :: Proxy sublayout) q
257− (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
258382
259383 where pname = symbolVal (Proxy :: Proxy sym)
260384 --p prm = QueryPartParam $ (fmap . fmap) (toQueryParam) prm
@@ -262,6 +386,8 @@ instance (KnownSymbol sym, ToHttpApiData a, HasClient t m sublayout, Reflex t)
262386 p prm = QueryPartParam $ fmap qParamToQueryPart prm -- (fmap . fmap) (unpack . toQueryParam) prm
263387 paramPair = (T.pack pname, p mparam)
264388
389+
390+
265391-- | If you use a 'QueryParams' in one of your endpoints in your API,
266392-- the corresponding querying function will automatically take
267393-- an additional argument, a list of values of the type specified
@@ -290,21 +416,22 @@ instance (KnownSymbol sym, ToHttpApiData a, HasClient t m sublayout, Reflex t)
290416-- > -- 'getBooksBy []' for all books
291417-- > -- 'getBooksBy ["Isaac Asimov", "Robert A. Heinlein"]'
292418-- > -- to get all books by Asimov and Heinlein
293−instance (KnownSymbol sym, ToHttpApiData a, HasClient t m sublayout, Reflex t)
294− => 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
295421
296− type Client t m (QueryParams sym a :> sublayout) =
297− 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
298424
299− clientWithRoute Proxy q req baseurl paramlist =
300− 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
301427
302428 where req' = req { qParams = (T.pack pname, params') : qParams req }
303429 pname = symbolVal (Proxy :: Proxy sym)
304− params' = QueryPartParams $ (fmap . fmap) (toQueryParam)
430+ params' = QueryPartParams $ (fmap . fmap) toQueryParam
305431 paramlist
306432
307433
434+
308435-- | If you use a 'QueryFlag' in one of your endpoints in your API,
309436-- the corresponding querying function will automatically take
310437-- an additional 'Bool' argument.
@@ -329,49 +456,42 @@ instance (KnownSymbol sym, ToHttpApiData a, HasClient t m sublayout, Reflex t)
329456-- > -- 'getBooksBy True' to only get _already published_ books
330457
331458-- TODO Bring back
332−instance (KnownSymbol sym, HasClient t m sublayout, Reflex t)
333− => 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
334461
335− type Client t m (QueryFlag sym :> sublayout) =
336− 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
337464
338− clientWithRoute Proxy q req baseurl flag =
339− 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
340467
341468 where req' = req { qParams = thisPair : qParams req }
342469 thisPair = (T.pack pName, QueryPartFlag flag) :: (Text, QueryPart t)
343470 pName = symbolVal (Proxy :: Proxy sym)
344471
345472
346−-- | Pick a 'Method' and specify where the server you want to query is. You get
347−-- back the full `Response`.
348−-- TODO redo
349−instance (MonadWidget t m) => HasClient t m Raw where
350− type Client t m Raw = Dynamic t (Either Text (XhrRequest ()))
351− -> Event t ()
352− -> m (Event t (ReqResult ()))
353−
354− -- clientWithRoute :: Proxy Raw -> Proxy m -> Req -> BaseUrl -> Client t m Raw
355− clientWithRoute _ _ _ baseurl xhrs triggers = do
356− let xhrs' = liftA2 (\x path -> case x of
357− Left e -> Left e
358− Right jx -> Right $ jx {_xhrRequest_url = path
359− <> _xhrRequest_url jx})
360− xhrs
361− (showBaseUrl <$> baseurl)
362− reqs = tagPromptlyDyn xhrs' triggers
363− okReq = fmapMaybe hush reqs
364− badReq = fmapMaybe tattle reqs
365− resps <- performRequestAsync okReq
366− return $ leftmost [fmap (ResponseSuccess () ) resps
367− ,fmap RequestFailure badReq]
368−
369−
370−hush :: Either e a -> Maybe a
371−hush = either (const Nothing) Just
372−
373−tattle :: Either e a -> Maybe e
374−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+
375495
376496-- | If you use a 'ReqBody' in one of your endpoints in your API,
377497-- the corresponding querying function will automatically take
@@ -393,14 +513,14 @@ tattle = either Just (const Nothing)
393513-- > where host = BaseUrl Http "localhost" 8080
394514-- > -- then you can just use "addBook" to query that endpoint
395515
396−instance (MimeRender ct a, HasClient t m sublayout, Reflex t)
397− => 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
398518
399− type Client t m (ReqBody (ct ': cts) a :> sublayout) =
400− 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
401521
402− clientWithRoute Proxy q req baseurl body =
403− 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
404524 where req' = req { reqBody = bodyBytesCT }
405525 ctProxy = Proxy :: Proxy ct
406526 ctString = T.pack $ show $ contentType ctProxy
@@ -408,43 +528,49 @@ instance (MimeRender ct a, HasClient t m sublayout, Reflex t)
408528 (\b -> (mimeRender ctProxy b, ctString))
409529 body
410530
531+
532+
411533-- | Make the querying function append @path@ to the request path.
412−instance (KnownSymbol path, HasClient t m sublayout, Reflex t) => HasClient t m (path :> sublayout) where
413− 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
414536
415− clientWithRoute Proxy q req baseurl =
416− clientWithRoute (Proxy :: Proxy sublayout) q
417− (prependToPathParts (pure (Right $ T.pack p)) req)
418− 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
419540
420541 where p = symbolVal (Proxy :: Proxy path)
421542
422−instance HasClient t m api => HasClient t m (Vault :> api) where
423− type Client t m (Vault :> api) = Client t m api
424543
425− clientWithRoute Proxy q req baseurl =
426− 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+
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
427553
428−instance HasClient t m api => HasClient t m (RemoteHost :> api) where
429− type Client t m (RemoteHost :> api) = Client t m api
554+ clientWithRouteAndResultHandler Proxy =
555+ clientWithRouteAndResultHandler (Proxy :: Proxy api)
430556
431− clientWithRoute Proxy q req baseurl =
432− clientWithRoute (Proxy :: Proxy api) q req baseurl
433557
434−instance HasClient t m api => HasClient t m (IsSecure :> api) where
435− type Client t m (IsSecure :> api) = Client t m api
436558
437− clientWithRoute Proxy q req baseurl =
438− clientWithRoute (Proxy :: Proxy api) q req baseurl
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
439561
440−instance (HasClient t m api, Reflex t)
441− => HasClient t m (BasicAuth realm usr :> api) where
562+ clientWithRouteAndResultHandler Proxy =
563+ clientWithRouteAndResultHandler (Proxy :: Proxy api)
442564
443− type Client t m (BasicAuth realm usr :> api) = Dynamic t (Maybe BasicAuthData)
444− -> Client t m api
445565
446− clientWithRoute Proxy q req baseurl authdata =
447− clientWithRoute (Proxy :: Proxy api) q req' baseurl
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
448574 where
449575 req' = req { authData = Just authdata }
450576
@@ -470,3 +596,29 @@ non-empty lists, but is otherwise more specific, no instance will be overall
470596more specific. This in turn generally means adding yet another instance (one
471597for empty and one for non-empty lists).
472598-}
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