@@ -1,44 +1,95 @@
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 TypeFamilies #-}
10−{-# LANGUAGE TypeOperators #-}
11−{-# LANGUAGE UndecidableInstances #-}
12−{-# LANGUAGE MultiParamTypeClasses #-}
13−
14−#include "overlapping-compat.h"
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
21+
22+-- #include "overlapping-compat.h"
1523-- | This module provides 'client' which can automatically generate
1624-- querying functions for each endpoint just from the type representing your
1725-- API.
1826module Servant.Reflex
1927 ( client
20− , HasClient(..)
21− , ServantError(..)
28+ , clientWithOpts
29+ , clientWithOptsAndResultHandler
30+ , clientWithRoute
31+ , clientWithRouteAndResultHandler
32+ , BuildHeaderKeysTo(..)
33+ , toHeaders
34+ , HasClient
35+ , Client
36+ , module Servant.Common.Req
2237 , module Servant.Common.BaseUrl
2338 ) where
2439
25−#if !MIN_VERSION_base(4,8,0)
26−import Control.Applicative ((<$>))
27−#endif
28−import Control.Monad.Trans.Except
29−import Data.ByteString.Lazy (ByteString)
30−import Data.List
31−import Data.Proxy
32−import Data.String.Conversions
33−import Data.Text (unpack)
34−import GHC.TypeLits
35−import Network.HTTP.Media
36−import qualified Network.HTTP.Types as H
37−import qualified Network.HTTP.Types.Header as HTTP
38−import Servant.API
39−import Servant.Common.BaseUrl
40−import Servant.Common.Req
41−import Reflex.Dom.Xhr
40+------------------------------------------------------------------------------
41+import 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 (..))
47+import qualified Data.Set as Set
48+import Data.Text (Text)
49+import qualified Data.Text as T
50+import qualified Data.Text.Encoding as E
51+import GHC.Exts (Constraint)
52+import GHC.TypeLits (KnownSymbol, symbolVal)
53+import Servant.API ((:<|>) (..), (:>), BasicAuth,
54+ BasicAuthData, BuildHeadersTo (..),
55+ Capture, Header, Headers (..),
56+ HttpVersion, IsSecure,
57+ MimeRender (..), MimeUnrender,
58+ NoContent, QueryFlag, QueryParam',
59+ QueryParams, Raw, ReflectMethod (..),
60+ RemoteHost, ReqBody,
61+ ToHttpApiData (..), Vault, Verb,
62+ contentType)
63+import Servant.API.Description (Summary)
64+import qualified Servant.Auth as Auth
65+
66+import Reflex.Dom.Core (Dynamic, Event, Reflex,
67+ XhrRequest (..), XhrResponse (..),
68+ XhrResponseHeaders (..),
69+ attachPromptlyDynWith, constDyn, ffor,
70+ fmapMaybe, leftmost,
71+ performRequestsAsync)
72+------------------------------------------------------------------------------
73+import Servant.Common.BaseUrl (BaseUrl(..), Scheme(..), baseUrlWidget,
74+ showBaseUrl,
75+ SupportsServantReflex)
76+import Servant.Common.Req (ClientOptions(..),
77+ defaultClientOptions,
78+ Req, ReqResult(..), QParam(..),
79+ QueryPart(..), addHeader, authData,
80+ defReq, evalResponse, prependToPathParts,
81+ -- performRequestCT,
82+ performRequestsCT,
83+ -- performRequestNoBody,
84+ performRequestsNoBody,
85+ performSomeRequestsAsync,
86+ qParamToQueryPart, reqBody,
87+ reqSuccess, reqFailure,
88+ reqMethod, respHeaders,
89+ response,
90+ reqTag,
91+ qParams, withCredentials)
92+
4293
4394-- * Accessing APIs as a Client
4495
@@ -50,113 +101,193 @@ import Reflex.Dom.Xhr
50101-- > myApi :: Proxy MyApi
51102-- > myApi = Proxy
52103-- >
53−-- > getAllBooks :: Event t () -> m (Event t (Either XhrError ((),[Book])))
54−-- > postNewBook :: Behavior 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 layout) => Proxy layout -> Dynamic t BaseUrl -> Client layout
59−client p baseurl = clientWithRoute p 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+
60142
61143-- | This class lets us define how each API combinator
62144-- influences the creation of an HTTP request. It's mostly
63145-- an internal class, you can just use 'client'.
64−class HasClient t layout where
65− type Client t layout :: *
66− clientWithRoute :: Proxy layout -> Req t -> BaseUrl -> Client t layout
67−
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
69−instance (HasClient t a, HasClient t b) => HasClient t (a :<|> b) where
70− type Client t (a :<|> b) = Client t a :<|> Client t b
71− clientWithRoute Proxy req baseurl manager =
72− clientWithRoute (Proxy :: Proxy a) req baseurl :<|>
73− clientWithRoute (Proxy :: Proxy b) req baseurl
74176
75177-- Capture. Example:
76178-- > type MyApi = "books" :> Capture "isbn" Text :> Get '[JSON] Book
77179-- >
78180-- > myApi :: Proxy MyApi = Proxy
79181-- >
80−-- > getBook :: MonadWidget t m
182+-- > getBook :: SupportsServantReflex t m
81183-- => Dynamic t BaseUrl
82−-- -> Behavior t (Maybe Text)
83−-- -> Event t ()
84−-- -> m (Event t (Either XhrError (Text, Book)))
184+-- -> Dynamic t (Maybe Text)
185+-- -> Event t l
186+-- -> m (Event t (l, ReqResult Book))
85187-- > getBook = client myApi (constDyn host)
86−instance (Reflex t, KnownSymbol capture, ToHttpApiData a, HasClient t sublayout)
87− => HasClient t (Capture capture a :> sublayout) where
88188
89− type Client t (Capture capture a :> sublayout) =
90− Behavior t (Maybe a) -> Client t sublayout
189+instance (SupportsServantReflex t m, ToHttpApiData a, HasClient t m sublayout tag)
190+ => HasClient t m (Capture capture a :> sublayout) tag where
191+
192+ type Client t m (Capture capture a :> sublayout) tag =
193+ Dynamic t (Either Text a) -> Client t m sublayout tag
91194
92− clientWithRoute Proxy req baseurl val =
93− clientWithRoute (Proxy :: Proxy sublayout)
94− (appendToPathParts p req)
95− baseurl
195+ clientWithRouteAndResultHandler Proxy q t req baseurl opts wrap val =
196+ clientWithRouteAndResultHandler
197+ (Proxy :: Proxy sublayout) q t (prependToPathParts p req) baseurl opts wrap
198+ where p = (fmap . fmap) (toUrlPiece) val
96199
97− where p = fmap (unpack . toUrlPiece) val
98200
99201-- VERB (Returning content) --
100−instance OVERLAPPABLE_
202+instance {-# OVERLAPPABLE #-}
101203 -- Note [Non-Empty Content Types]
102− (MimeUnrender ct a, ReflectMethod method, cts' ~ (ct ': cts)
103− ) => HasClient t (Verb method status cts' a) where
104− type Client t (Verb method status cts' a) =
105− Event t () -> m (Event t (Either XhrError 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))
106208 -- TODO how to access input types here?
107209 -- ExceptT ServantError IO a
108− clientWithRoute Proxy req baseurl =
109− performRequestCT (Proxy :: Proxy ct) method req baseurl
110− where method = reflectMethod (Proxy :: Proxy method)
111−
112−-- VERB (No content) --
113−instance OVERLAPPING_
114− (ReflectMethod method, Reflex t) =>
115− HasClient t (Verb method status cts NoContent) where
116− type Client t (Verb method status cts NoContent) =
117− Event t () -> m (Event t (Either XhrError ()))
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)
213+ req' = req { reqMethod = method }
214+
215+
216+-- -- VERB (No content) --
217+instance {-# 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))
118222 -- TODO: how to access input types here?
119223 -- ExceptT ServantError IO NoContent
120− clientWithRoute Proxy req baseurl manager =
121− performRequestNoBody method req baseurl
122− where method = 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)
227+
228+
229+toHeaders :: BuildHeadersTo ls => ReqResult tag a -> ReqResult tag (Headers ls a)
230+toHeaders r =
231+ let hdrs = maybe []
232+ (\xhr -> fmap (\(h,v) -> (CI.map E.encodeUtf8 h, E.encodeUtf8 v))
233+ (Map.toList $ _xhrResponse_headers xhr))
234+ (response r)
235+ in ffor r $ \a -> Headers {getResponse = a ,getHeadersHList = buildHeadersTo hdrs}
236+
237+
238+class BuildHeaderKeysTo hs where
239+ buildHeaderKeysTo :: Proxy hs -> [CI.CI T.Text]
240+
241+instance {-# OVERLAPPABLE #-} BuildHeaderKeysTo '[]
242+ where buildHeaderKeysTo _ = []
243+
244+instance {-# 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+
123251
124252-- HEADERS Verb (Content) --
125253-- Headers combinator not treated in fully general case,
126254-- in order to deny instances for (Headers ls (Capture "id" Int)),
127255-- a combinator that wouldn't make sense
128−instance OVERLAPPING_
256+-- TODO Overlapping??
257+instance {-# OVERLAPPABLE #-}
129258 -- Note [Non-Empty Content Types]
130− ( MimeUnrender ct a, BuildHeadersTo ls,
259+ ( MimeUnrender ct a, BuildHeadersTo ls, BuildHeaderKeysTo ls,
131260 ReflectMethod method, cts' ~ (ct ': cts),
132− Reflex t
133− ) => HasClient (Verb method status cts' (Headers ls a)) where
134− type Client (Verb method status cts' (Headers ls a))
135− = Event t () -> m (Event t (Either XhrError ()))
136− -- ExceptT ServantError IO (Headers ls a)
137− clientWithRoute Proxy req baseurl manager = do
138− let method = reflectMethod (Proxy :: Proxy method)
139− (hdrs, resp) <- performRequestCT (Proxy :: Proxy ct) method req baseurl manager
140− return $ Headers { getResponse = resp
141− , getHeadersHList = buildHeadersTo hdrs
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
266+ 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
269+ where req' = req { respHeaders =
270+ OnlyHeaders (Set.fromList (buildHeaderKeysTo (Proxy :: Proxy ls)))
142271 }
143272
273+
144274-- HEADERS Verb (No content) --
145−instance OVERLAPPING_
146− ( BuildHeadersTo ls, ReflectMethod method,
147− Reflex t
148− ) => HasClient (Verb method status cts (Headers ls NoContent)) where
149− type Client (Verb method status cts (Headers ls NoContent))
150− = Event t () -> m (Event t (Either XhrError ()))
151− -- ExceptT ServantError IO (Headers ls NoContent)
152− clientWithRoute Proxy req baseurl = do
153− let method = reflectMethod (Proxy :: Proxy method)
154− hdrs <- performRequestNoBody method req baseurl manager
155− return $ Headers { getResponse = NoContent
156− , getHeadersHList = buildHeadersTo hdrs
275+instance {-# OVERLAPPABLE #-}
276+ ( 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
282+ let method = E.decodeUtf8 $ reflectMethod (Proxy :: Proxy method)
283+ resp <- fmap runIdentity <$> performRequestsNoBody method (constDyn $ Identity req') baseurl opts trigs
284+ wrap $ toHeaders <$> resp
285+ where req' = req {respHeaders =
286+ OnlyHeaders (Set.fromList (buildHeaderKeysTo (Proxy :: Proxy ls)))
157287 }
158288
159289
290+
160291-- HEADER
161292-- > newtype Referer = Referer { referrer :: Text }
162293-- > deriving (Eq, Show, Generic, FromText, ToHttpApiData)
@@ -171,33 +302,46 @@ instance OVERLAPPING_
171302-- > -- then you can just use "viewRefer" to query that endpoint
172303-- > -- specifying Nothing or e.g Just "http://haskell.org/" as arguments
173304instance (KnownSymbol sym, ToHttpApiData a,
174− HasClient sublayout, Reflex t)
175− => HasClient (Header sym a :> sublayout) where
305+ HasClient t m sublayout tag, SupportsServantReflex t m)
306+ => HasClient t m (Header sym a :> sublayout) tag where
307+
308+ type Client t m (Header sym a :> sublayout) tag =
309+ Dynamic t (Either Text a) -> Client t m sublayout tag
310+
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
316+ where hname = T.pack $ symbolVal (Proxy :: Proxy sym)
176317
177− type Client t (Header sym a :> sublayout) =
178− Behavior t (Maybe a) -> Client t sublayout
179318
180− clientWithRoute Proxy req baseurl mval =
181− clientWithRoute (Proxy :: Proxy sublayout)
182− (maybe req
183− (\value -> Servant.Common.Req.addHeader hname value req)
184− mval
185− )
186− baseurl
187− manager
188319
189− where hname = symbolVal (Proxy :: Proxy sym)
190320
191321-- | Using a 'HttpVersion' combinator in your API doesn't affect the client
192322-- functions.
193−instance HasClient sublayout
194− => HasClient (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)
342+
195343
196− type Client (HttpVersion :> sublayout) =
197− Client sublayout
198344
199− clientWithRoute Proxy =
200− clientWithRoute (Proxy :: Proxy sublayout)
201345
202346-- | If you use a 'QueryParam' in one of your endpoints in your API,
203347-- the corresponding querying function will automatically take
@@ -225,25 +369,24 @@ instance HasClient sublayout
225369-- > -- then you can just use "getBooksBy" to query that endpoint.
226370-- > -- 'getBooksBy Nothing' for all books
227371-- > -- 'getBooksBy (Just "Isaac Asimov")' to get all books by Isaac Asimov
228−instance (KnownSymbol sym, ToHttpApiData a, HasClient sublayout)
229− => HasClient (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
230374
231− type Client (QueryParam sym a :> sublayout) =
232− Maybe a -> Client sublayout
375+ type Client t m (QueryParam' mods sym a :> sublayout) tag =
376+ Dynamic t (QParam a) -> Client t m sublayout tag
233377
234378 -- if mparam = Nothing, we don't add it to the query string
235− clientWithRoute Proxy req baseurl manager mparam =
236− clientWithRoute (Proxy :: Proxy sublayout)
237− (maybe req
238− (flip (appendToQueryString pname) req . Just)
239− mparamText
240− )
241− baseurl
242− manager
243−
244− where pname = cs pname'
245− pname' = symbolVal (Proxy :: Proxy sym)
246− mparamText = fmap toQueryParam mparam
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
382+
383+ where pname = symbolVal (Proxy :: Proxy sym)
384+ --p prm = QueryPartParam $ (fmap . fmap) (toQueryParam) prm
385+ --paramPair = (T.pack pname, p mparam)
386+ p prm = QueryPartParam $ fmap qParamToQueryPart prm -- (fmap . fmap) (unpack . toQueryParam) prm
387+ paramPair = (T.pack pname, p mparam)
388+
389+
247390
248391-- | If you use a 'QueryParams' in one of your endpoints in your API,
249392-- the corresponding querying function will automatically take
@@ -273,23 +416,21 @@ instance (KnownSymbol sym, ToHttpApiData a, HasClient sublayout)
273416-- > -- 'getBooksBy []' for all books
274417-- > -- 'getBooksBy ["Isaac Asimov", "Robert A. Heinlein"]'
275418-- > -- to get all books by Asimov and Heinlein
276−instance (KnownSymbol sym, ToHttpApiData a, HasClient sublayout)
277− => HasClient (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
278421
279− type Client (QueryParams sym a :> sublayout) =
280− [a] -> Client sublayout
422+ type Client t m (QueryParams sym a :> sublayout) tag =
423+ Dynamic t [a] -> Client t m sublayout tag
424+
425+ clientWithRouteAndResultHandler Proxy q t req baseurl opts wrap paramlist =
426+ clientWithRouteAndResultHandler (Proxy :: Proxy sublayout) q t req' baseurl opts wrap
427+
428+ where req' = req { qParams = (T.pack pname, params') : qParams req }
429+ pname = symbolVal (Proxy :: Proxy sym)
430+ params' = QueryPartParams $ (fmap . fmap) toQueryParam
431+ paramlist
281432
282− clientWithRoute Proxy req baseurl manager paramlist =
283− clientWithRoute (Proxy :: Proxy sublayout)
284− (foldl' (\ req' -> maybe req' (flip (appendToQueryString pname) req' . Just))
285− req
286− paramlist'
287− )
288− baseurl manager
289433
290− where pname = cs pname'
291− pname' = symbolVal (Proxy :: Proxy sym)
292− paramlist' = map (Just . toQueryParam) paramlist
293434
294435-- | If you use a 'QueryFlag' in one of your endpoints in your API,
295436-- the corresponding querying function will automatically take
@@ -313,31 +454,44 @@ instance (KnownSymbol sym, ToHttpApiData a, HasClient sublayout)
313454-- > -- then you can just use "getBooks" to query that endpoint.
314455-- > -- 'getBooksBy False' for all books
315456-- > -- 'getBooksBy True' to only get _already published_ books
316−instance (KnownSymbol sym, HasClient sublayout)
317− => HasClient (QueryFlag sym :> sublayout) where
318457
319− type Client (QueryFlag sym :> sublayout) =
320− Bool -> Client sublayout
458+-- TODO Bring back
459+instance (KnownSymbol sym, HasClient t m sublayout tag, Reflex t)
460+ => HasClient t m (QueryFlag sym :> sublayout) tag where
461+
462+ type Client t m (QueryFlag sym :> sublayout) tag =
463+ Dynamic t Bool -> Client t m sublayout tag
464+
465+ clientWithRouteAndResultHandler Proxy q t req baseurl opts wrap flag =
466+ clientWithRouteAndResultHandler (Proxy :: Proxy sublayout) q t req' baseurl opts wrap
467+
468+ where req' = req { qParams = thisPair : qParams req }
469+ thisPair = (T.pack pName, QueryPartFlag flag) :: (Text, QueryPart t)
470+ pName = symbolVal (Proxy :: Proxy sym)
471+
472+
321473
322− clientWithRoute Proxy req baseurl manager flag =
323− clientWithRoute (Proxy :: Proxy sublayout)
324− (if flag
325− then appendToQueryString paramname Nothing req
326− else req
327− )
328− baseurl manager
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 ()))
329479
330− where paramname = cs $ symbolVal (Proxy :: Proxy sym)
480+ clientWithRouteAndResultHandler _ _ _ _ baseurl _ wrap xhrs triggers = do
331481
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 ())
332489
333−-- | Pick a 'Method' and specify where the server you want to query is. You get
334−-- back the full `Response`.
335−instance HasClient Raw where
336− type Client Raw = H.Method -> ExceptT ServantError IO (Int, ByteString, MediaType, [HTTP.Header], Response ByteString)
490+ resps <- performRequestsAsync okReq
491+ wrap $ leftmost [ uncurry RequestFailure <$> badReq
492+ , evalResponse (const $ Right ()) <$> resps
493+ ]
337494
338− clientWithRoute :: Proxy Raw -> Req -> BaseUrl -> Manager -> Client Raw
339− clientWithRoute Proxy req baseurl manager httpMethod = do
340− performRequest httpMethod req baseurl manager
341495
342496-- | If you use a 'ReqBody' in one of your endpoints in your API,
343497-- the corresponding querying function will automatically take
@@ -355,58 +509,76 @@ instance HasClient Raw where
355509-- > myApi = Proxy
356510-- >
357511-- > addBook :: Book -> ExceptT String IO Book
358−-- > addBook = client myApi host manager
512+-- > addBook = client myApi host
359513-- > where host = BaseUrl Http "localhost" 8080
360514-- > -- then you can just use "addBook" to query that endpoint
361−instance (MimeRender ct a, HasClient sublayout)
362− => HasClient (ReqBody (ct ': cts) a :> sublayout) where
363515
364− type Client (ReqBody (ct ': cts) a :> sublayout) =
365− a -> Client sublayout
516+instance (MimeRender ct a, HasClient t m sublayout tag, Reflex t)
517+ => HasClient t m (ReqBody (ct ': cts) a :> sublayout) tag where
518+
519+ type Client t m (ReqBody (ct ': cts) a :> sublayout) tag =
520+ Dynamic t (Either Text a) -> Client t m sublayout tag
521+
522+ clientWithRouteAndResultHandler Proxy q t req baseurl opts wrap body =
523+ clientWithRouteAndResultHandler (Proxy :: Proxy sublayout) q t req' baseurl opts wrap
524+ where req' = req { reqBody = bodyBytesCT }
525+ ctProxy = Proxy :: Proxy ct
526+ ctString = T.pack $ show $ contentType ctProxy
527+ bodyBytesCT = Just $ (fmap . fmap)
528+ (\b -> (mimeRender ctProxy b, ctString))
529+ body
530+
366531
367− clientWithRoute Proxy req baseurl manager body =
368− clientWithRoute (Proxy :: Proxy sublayout)
369− (let ctProxy = Proxy :: Proxy ct
370− in setRQBody (mimeRender ctProxy body)
371− (contentType ctProxy)
372− req
373− )
374− baseurl manager
375532
376533-- | Make the querying function append @path@ to the request path.
377−instance (KnownSymbol path, HasClient sublayout) => HasClient (path :> sublayout) where
378− type Client (path :> sublayout) = Client 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
379536
380− clientWithRoute Proxy req baseurl manager =
381− clientWithRoute (Proxy :: Proxy sublayout)
382− (appendToPath p req)
383− baseurl manager
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
384540
385541 where p = symbolVal (Proxy :: Proxy path)
386542
387−instance HasClient api => HasClient (Vault :> api) where
388− type Client (Vault :> api) = Client api
389543
390− clientWithRoute Proxy req baseurl manager =
391− clientWithRoute (Proxy :: Proxy api) req baseurl manager
544+instance HasClient t m api tag => HasClient t m (Vault :> api) tag where
545+ type Client t m (Vault :> api) tag = Client t m api tag
546+
547+ clientWithRouteAndResultHandler Proxy =
548+ clientWithRouteAndResultHandler (Proxy :: Proxy api)
549+
550+
551+instance HasClient t m api tag => HasClient t m (RemoteHost :> api) tag where
552+ type Client t m (RemoteHost :> api) tag = Client t m api tag
553+
554+ clientWithRouteAndResultHandler Proxy =
555+ clientWithRouteAndResultHandler (Proxy :: Proxy api)
392556
393−instance HasClient api => HasClient (RemoteHost :> api) where
394− type Client (RemoteHost :> api) = Client api
395557
396− clientWithRoute Proxy req baseurl manager =
397− clientWithRoute (Proxy :: Proxy api) req baseurl manager
398558
399−instance HasClient api => HasClient (IsSecure :> api) where
400− type Client (IsSecure :> api) = Client api
559+instance HasClient t m api tag => HasClient t m (IsSecure :> api) tag where
560+ type Client t m (IsSecure :> api) tag = Client t m api tag
401561
402− clientWithRoute Proxy req baseurl manager =
403− clientWithRoute (Proxy :: Proxy api) req baseurl manager
562+ clientWithRouteAndResultHandler Proxy =
563+ clientWithRouteAndResultHandler (Proxy :: Proxy api)
404564
405−instance HasClient subapi =>
406− HasClient (WithNamedConfig name config subapi) where
407565
408− type Client (WithNamedConfig name config subapi) = Client subapi
409− clientWithRoute Proxy = clientWithRoute (Proxy :: Proxy subapi)
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
574+ where
575+ req' = req { authData = Just authdata }
576+
577+-- instance HasClient t m subapi =>
578+-- HasClient t m (WithNamedConfig name config subapi) where
579+
580+-- type Client t m (WithNamedConfig name config subapi) = Client t m subapi
581+-- clientWithRoute Proxy q = clientWithRoute (Proxy :: Proxy subapi) q
410582
411583
412584{- Note [Non-Empty Content Types]
@@ -424,3 +596,29 @@ non-empty lists, but is otherwise more specific, no instance will be overall
424596more specific. This in turn generally means adding yet another instance (one
425597for empty and one for non-empty lists).
426598-}
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