@@ -1,23 +1,16 @@
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
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 #-}
2114
2215-- #include "overlapping-compat.h"
2316-- | This module provides 'client' which can automatically generate
@@ -25,71 +18,27 @@
2518-- API.
2619module Servant.Reflex
2720 ( client
28− , clientWithOpts
29− , clientWithOptsAndResultHandler
30− , clientWithRoute
31− , clientWithRouteAndResultHandler
32− , BuildHeaderKeysTo(..)
33− , toHeaders
34− , HasClient
35− , Client
21+ , HasClient(..)
3622 , module Servant.Common.Req
3723 , module Servant.Common.BaseUrl
3824 ) where
3925
40−------------------------------------------------------------------------------
4126import Control.Applicative
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 (..))
4727import 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
32+import qualified Data.Map as Map
4833import Data.Text (Text)
4934import 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−
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
9342
9443-- * Accessing APIs as a Client
9544
@@ -101,153 +50,98 @@ import Servant.Common.Req (ClientOptions(..),
10150-- > myApi :: Proxy MyApi
10251-- > myApi = Proxy
10352-- >
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)))
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)))
10756-- > (getAllBooks :<|> postNewBook) = client myApi host
10857-- > where host = constDyn $ BaseUrl Http "localhost" 8080
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−
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
14261
14362-- | This class lets us define how each API combinator
14463-- influences the creation of an HTTP request. It's mostly
14564-- an internal class, you can just use 'client'.
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
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
17568
17669
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+
17776-- Capture. Example:
17877-- > type MyApi = "books" :> Capture "isbn" Text :> Get '[JSON] Book
17978-- >
18079-- > myApi :: Proxy MyApi = Proxy
18180-- >
182−-- > getBook :: SupportsServantReflex t m
81+-- > getBook :: MonadWidget t m
18382-- => Dynamic t BaseUrl
18483-- -> Dynamic t (Maybe Text)
185−-- -> Event t l
186−-- -> m (Event t (l, ReqResult Book))
84+-- -> Event t ()
85+-- -> m (Event t (Either XhrError (Text, Book)))
18786-- > 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
18889
189−instance (SupportsServantReflex t m, ToHttpApiData a, HasClient t m sublayout tag)
190− => HasClient t m (Capture capture a :> sublayout) tag where
90+ type Client t m (Capture capture a :> sublayout) =
91+ Dynamic t (Either Text a) -> Client t m sublayout
19192
192− type Client t m (Capture capture a :> sublayout) tag =
193− Dynamic t (Either Text a) -> Client t m sublayout tag
93+ clientWithRoute Proxy q req baseurl val =
94+ clientWithRoute (Proxy :: Proxy sublayout)
95+ q
96+ (prependToPathParts p req)
97+ baseurl
19498
195− clientWithRouteAndResultHandler Proxy q t req baseurl opts wrap val =
196− clientWithRouteAndResultHandler
197− (Proxy :: Proxy sublayout) q t (prependToPathParts p req) baseurl opts wrap
19899 where p = (fmap . fmap) (toUrlPiece) val
199100
200−
201101-- VERB (Returning content) --
202102instance {-# OVERLAPPABLE #-}
203103 -- Note [Non-Empty Content Types]
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))
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))
208108 -- TODO how to access input types here?
209109 -- ExceptT ServantError IO a
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)
110+ clientWithRoute Proxy _ req baseurl =
111+ performRequestCT (Proxy :: Proxy ct) method req' baseurl
112+ where method = decodeUtf8 $ reflectMethod (Proxy :: Proxy method)
213113 req' = req { reqMethod = method }
214114
215−
216115-- -- VERB (No content) --
217116instance {-# OVERLAPPING #-}
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))
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))
222121 -- TODO: how to access input types here?
223122 -- ExceptT ServantError IO NoContent
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)
123+ clientWithRoute Proxy _ req baseurl =
124+ performRequestNoBody method req baseurl
125+ where method = decodeUtf8 $ reflectMethod (Proxy :: Proxy method)
227126
228−
229−toHeaders :: BuildHeadersTo ls => ReqResult tag a -> ReqResult tag (Headers ls a)
127+toHeaders :: BuildHeadersTo ls => ReqResult a -> ReqResult (Headers ls a)
230128toHeaders r =
231− let hdrs = maybe []
232− (\xhr -> fmap (\(h,v) -> (CI.map E.encodeUtf8 h, E.encodeUtf8 v))
129+ let toBS = E.encodeUtf8
130+ hdrs = maybe []
131+ (\xhr -> fmap (\(h,v) -> (mk (toBS h), toBS v))
233132 (Map.toList $ _xhrResponse_headers xhr))
234133 (response r)
235134 in ffor r $ \a -> Headers {getResponse = a ,getHeadersHList = buildHeadersTo hdrs}
236135
237−
238136class BuildHeaderKeysTo hs where
239− buildHeaderKeysTo :: Proxy hs -> [CI.CI T.Text]
137+ buildHeaderKeysTo :: Proxy hs -> [T.Text]
240138
241139instance {-# OVERLAPPABLE #-} BuildHeaderKeysTo '[]
242140 where buildHeaderKeysTo _ = []
243141
244142instance {-# OVERLAPPABLE #-} (BuildHeaderKeysTo xs, KnownSymbol h)
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−
143+ => BuildHeaderKeysTo '[(Header h v) ': xs] where
144+ buildHeaderKeysTo _ = (T.pack $ symbolVal (Proxy :: Proxy h)) : buildHeaderKeysTo (Proxy :: Proxy xs)
251145
252146-- HEADERS Verb (Content) --
253147-- Headers combinator not treated in fully general case,
@@ -258,36 +152,34 @@ instance {-# OVERLAPPABLE #-}
258152 -- Note [Non-Empty Content Types]
259153 ( MimeUnrender ct a, BuildHeadersTo ls, BuildHeaderKeysTo ls,
260154 ReflectMethod method, cts' ~ (ct ': cts),
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
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
266160 let method = E.decodeUtf8 $ reflectMethod (Proxy :: Proxy method)
267− resp <- fmap runIdentity <$> performRequestsCT (Proxy :: Proxy ct) method (constDyn $ Identity req') baseurl opts trigs
268− wrap $ toHeaders <$> resp
161+ resp <- performRequestCT (Proxy :: Proxy ct) method req' baseurl
162+ return $ (fmap . fmap) toHeaders resp
269163 where req' = req { respHeaders =
270164 OnlyHeaders (Set.fromList (buildHeaderKeysTo (Proxy :: Proxy ls)))
271165 }
272166
273−
274167-- HEADERS Verb (No content) --
275168instance {-# OVERLAPPABLE #-}
276169 ( BuildHeadersTo ls, BuildHeaderKeysTo ls, ReflectMethod method,
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
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
282175 let method = E.decodeUtf8 $ reflectMethod (Proxy :: Proxy method)
283− resp <- fmap runIdentity <$> performRequestsNoBody method (constDyn $ Identity req') baseurl opts trigs
284− wrap $ toHeaders <$> resp
176+ resp <- performRequestNoBody method req' baseurl
177+ return $ (fmap . fmap) toHeaders resp
285178 where req' = req {respHeaders =
286179 OnlyHeaders (Set.fromList (buildHeaderKeysTo (Proxy :: Proxy ls)))
287180 }
288181
289182
290−
291183-- HEADER
292184-- > newtype Referer = Referer { referrer :: Text }
293185-- > deriving (Eq, Show, Generic, FromText, ToHttpApiData)
@@ -302,45 +194,29 @@ instance {-# OVERLAPPABLE #-}
302194-- > -- then you can just use "viewRefer" to query that endpoint
303195-- > -- specifying Nothing or e.g Just "http://haskell.org/" as arguments
304196instance (KnownSymbol sym, ToHttpApiData a,
305− HasClient t m sublayout tag, SupportsServantReflex t m)
306− => HasClient t m (Header sym a :> sublayout) tag where
197+ HasClient t m sublayout, MonadWidget t m)
198+ => HasClient t m (Header sym a :> sublayout) where
307199
308− type Client t m (Header sym a :> sublayout) tag =
309− Dynamic t (Either Text a) -> Client t m sublayout tag
200+ type Client t m (Header sym a :> sublayout) =
201+ Dynamic t (Either Text a) -> Client t m sublayout
310202
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
203+ clientWithRoute Proxy q req baseurl eVal =
204+ clientWithRoute (Proxy :: Proxy sublayout)
205+ q
206+ (Servant.Common.Req.addHeader hname eVal req)
207+ baseurl
316208 where hname = T.pack $ symbolVal (Proxy :: Proxy sym)
317209
318−
319−
320−
321210-- | Using a 'HttpVersion' combinator in your API doesn't affect the client
322211-- functions.
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)
212+instance HasClient t m sublayout
213+ => HasClient t m (HttpVersion :> sublayout) where
342214
215+ type Client t m (HttpVersion :> sublayout) =
216+ Client t m sublayout
343217
218+ clientWithRoute Proxy q =
219+ clientWithRoute (Proxy :: Proxy sublayout) q
344220
345221
346222-- | If you use a 'QueryParam' in one of your endpoints in your API,
@@ -369,16 +245,16 @@ instance (HasClient t m sublayout tag, KnownSymbol sym)
369245-- > -- then you can just use "getBooksBy" to query that endpoint.
370246-- > -- 'getBooksBy Nothing' for all books
371247-- > -- 'getBooksBy (Just "Isaac Asimov")' to get all books by Isaac Asimov
372−instance (KnownSymbol sym, ToHttpApiData a, HasClient t m sublayout tag, Reflex t)
373− => HasClient t m (QueryParam' mods sym a :> sublayout) tag where
248+instance (KnownSymbol sym, ToHttpApiData a, HasClient t m sublayout, Reflex t)
249+ => HasClient t m (QueryParam sym a :> sublayout) where
374250
375− type Client t m (QueryParam' mods sym a :> sublayout) tag =
376− Dynamic t (QParam a) -> Client t m sublayout tag
251+ type Client t m (QueryParam sym a :> sublayout) =
252+ Dynamic t (QParam a) -> Client t m sublayout
377253
378254 -- if mparam = Nothing, we don't add it to the query string
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
255+ clientWithRoute Proxy q req baseurl mparam =
256+ clientWithRoute (Proxy :: Proxy sublayout) q
257+ (req {qParams = paramPair : qParams req}) baseurl
382258
383259 where pname = symbolVal (Proxy :: Proxy sym)
384260 --p prm = QueryPartParam $ (fmap . fmap) (toQueryParam) prm
@@ -386,8 +262,6 @@ instance (KnownSymbol sym, ToHttpApiData a, HasClient t m sublayout tag, Reflex
386262 p prm = QueryPartParam $ fmap qParamToQueryPart prm -- (fmap . fmap) (unpack . toQueryParam) prm
387263 paramPair = (T.pack pname, p mparam)
388264
389−
390−
391265-- | If you use a 'QueryParams' in one of your endpoints in your API,
392266-- the corresponding querying function will automatically take
393267-- an additional argument, a list of values of the type specified
@@ -416,22 +290,21 @@ instance (KnownSymbol sym, ToHttpApiData a, HasClient t m sublayout tag, Reflex
416290-- > -- 'getBooksBy []' for all books
417291-- > -- 'getBooksBy ["Isaac Asimov", "Robert A. Heinlein"]'
418292-- > -- to get all books by Asimov and Heinlein
419−instance (KnownSymbol sym, ToHttpApiData a, HasClient t m sublayout tag, Reflex t)
420− => HasClient t m (QueryParams sym a :> sublayout) tag where
293+instance (KnownSymbol sym, ToHttpApiData a, HasClient t m sublayout, Reflex t)
294+ => HasClient t m (QueryParams sym a :> sublayout) where
421295
422− type Client t m (QueryParams sym a :> sublayout) tag =
423− Dynamic t [a] -> Client t m sublayout tag
296+ type Client t m (QueryParams sym a :> sublayout) =
297+ Dynamic t [a] -> Client t m sublayout
424298
425− clientWithRouteAndResultHandler Proxy q t req baseurl opts wrap paramlist =
426− clientWithRouteAndResultHandler (Proxy :: Proxy sublayout) q t req' baseurl opts wrap
299+ clientWithRoute Proxy q req baseurl paramlist =
300+ clientWithRoute (Proxy :: Proxy sublayout) q req' baseurl
427301
428302 where req' = req { qParams = (T.pack pname, params') : qParams req }
429303 pname = symbolVal (Proxy :: Proxy sym)
430− params' = QueryPartParams $ (fmap . fmap) toQueryParam
304+ params' = QueryPartParams $ (fmap . fmap) (toQueryParam)
431305 paramlist
432306
433307
434−
435308-- | If you use a 'QueryFlag' in one of your endpoints in your API,
436309-- the corresponding querying function will automatically take
437310-- an additional 'Bool' argument.
@@ -456,42 +329,49 @@ instance (KnownSymbol sym, ToHttpApiData a, HasClient t m sublayout tag, Reflex
456329-- > -- 'getBooksBy True' to only get _already published_ books
457330
458331-- TODO Bring back
459−instance (KnownSymbol sym, HasClient t m sublayout tag, Reflex t)
460− => HasClient t m (QueryFlag sym :> sublayout) tag where
332+instance (KnownSymbol sym, HasClient t m sublayout, Reflex t)
333+ => HasClient t m (QueryFlag sym :> sublayout) where
461334
462− type Client t m (QueryFlag sym :> sublayout) tag =
463− Dynamic t Bool -> Client t m sublayout tag
335+ type Client t m (QueryFlag sym :> sublayout) =
336+ Dynamic t Bool -> Client t m sublayout
464337
465− clientWithRouteAndResultHandler Proxy q t req baseurl opts wrap flag =
466− clientWithRouteAndResultHandler (Proxy :: Proxy sublayout) q t req' baseurl opts wrap
338+ clientWithRoute Proxy q req baseurl flag =
339+ clientWithRoute (Proxy :: Proxy sublayout) q req' baseurl
467340
468341 where req' = req { qParams = thisPair : qParams req }
469342 thisPair = (T.pack pName, QueryPartFlag flag) :: (Text, QueryPart t)
470343 pName = symbolVal (Proxy :: Proxy sym)
471344
472345
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−
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)
495375
496376-- | If you use a 'ReqBody' in one of your endpoints in your API,
497377-- the corresponding querying function will automatically take
@@ -513,14 +393,14 @@ instance SupportsServantReflex t m => HasClient t m Raw tag where
513393-- > where host = BaseUrl Http "localhost" 8080
514394-- > -- then you can just use "addBook" to query that endpoint
515395
516−instance (MimeRender ct a, HasClient t m sublayout tag, Reflex t)
517− => HasClient t m (ReqBody (ct ': cts) a :> sublayout) tag where
396+instance (MimeRender ct a, HasClient t m sublayout, Reflex t)
397+ => HasClient t m (ReqBody (ct ': cts) a :> sublayout) where
518398
519− type Client t m (ReqBody (ct ': cts) a :> sublayout) tag =
520− Dynamic t (Either Text a) -> Client t m sublayout tag
399+ type Client t m (ReqBody (ct ': cts) a :> sublayout) =
400+ Dynamic t (Either Text a) -> Client t m sublayout
521401
522− clientWithRouteAndResultHandler Proxy q t req baseurl opts wrap body =
523− clientWithRouteAndResultHandler (Proxy :: Proxy sublayout) q t req' baseurl opts wrap
402+ clientWithRoute Proxy q req baseurl body =
403+ clientWithRoute (Proxy :: Proxy sublayout) q req' baseurl
524404 where req' = req { reqBody = bodyBytesCT }
525405 ctProxy = Proxy :: Proxy ct
526406 ctString = T.pack $ show $ contentType ctProxy
@@ -528,49 +408,43 @@ instance (MimeRender ct a, HasClient t m sublayout tag, Reflex t)
528408 (\b -> (mimeRender ctProxy b, ctString))
529409 body
530410
531−
532−
533411-- | Make the querying function append @path@ to the request path.
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
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
536414
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
415+ clientWithRoute Proxy q req baseurl =
416+ clientWithRoute (Proxy :: Proxy sublayout) q
417+ (prependToPathParts (pure (Right $ T.pack p)) req)
418+ baseurl
540419
541420 where p = symbolVal (Proxy :: Proxy path)
542421
422+instance HasClient t m api => HasClient t m (Vault :> api) where
423+ type Client t m (Vault :> api) = Client t m api
543424
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
425+ clientWithRoute Proxy q req baseurl =
426+ clientWithRoute (Proxy :: Proxy api) q req baseurl
553427
554− clientWithRouteAndResultHandler Proxy =
555− clientWithRouteAndResultHandler (Proxy :: Proxy api)
428+instance HasClient t m api => HasClient t m (RemoteHost :> api) where
429+ type Client t m (RemoteHost :> api) = Client t m api
556430
431+ clientWithRoute Proxy q req baseurl =
432+ clientWithRoute (Proxy :: Proxy api) q req baseurl
557433
434+instance HasClient t m api => HasClient t m (IsSecure :> api) where
435+ type Client t m (IsSecure :> api) = Client t m api
558436
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
437+ clientWithRoute Proxy q req baseurl =
438+ clientWithRoute (Proxy :: Proxy api) q req baseurl
561439
562− clientWithRouteAndResultHandler Proxy =
563− clientWithRouteAndResultHandler (Proxy :: Proxy api)
440+instance (HasClient t m api, Reflex t)
441+ => HasClient t m (BasicAuth realm usr :> api) where
564442
443+ type Client t m (BasicAuth realm usr :> api) = Dynamic t (Maybe BasicAuthData)
444+ -> Client t m api
565445
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
446+ clientWithRoute Proxy q req baseurl authdata =
447+ clientWithRoute (Proxy :: Proxy api) q req' baseurl
574448 where
575449 req' = req { authData = Just authdata }
576450
@@ -596,29 +470,3 @@ non-empty lists, but is otherwise more specific, no instance will be overall
596470more specific. This in turn generally means adding yet another instance (one
597471for empty and one for non-empty lists).
598472-}
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