@@ -1,16 +1,23 @@
1−{-# LANGUAGE CPP #-}
1+{-# LANGUAGE AllowAmbiguousTypes #-}
2−{-# LANGUAGE DataKinds #-}
3+{-# LANGUAGE DataKinds #-}
3−{-# LANGUAGE FlexibleContexts #-}
4+{-# LANGUAGE FlexibleContexts #-}
4−{-# LANGUAGE FlexibleInstances #-}
5+{-# LANGUAGE FlexibleInstances #-}
6+{-# LANGUAGE GeneralizedNewtypeDeriving #-}
5−{-# LANGUAGE InstanceSigs #-}
7+{-# LANGUAGE InstanceSigs #-}
8+{-# LANGUAGE MultiParamTypeClasses #-}
6−{-# LANGUAGE OverloadedStrings #-}
9+{-# LANGUAGE OverloadedStrings #-}
7−{-# LANGUAGE PolyKinds #-}
10+{-# LANGUAGE PolyKinds #-}
11+{-# LANGUAGE Rank2Types #-}
8−{-# LANGUAGE ScopedTypeVariables #-}
12+{-# LANGUAGE ScopedTypeVariables #-}
9−{-# LANGUAGE TupleSections #-}
13+{-# LANGUAGE TupleSections #-}
10−{-# LANGUAGE TypeFamilies #-}
14+{-# LANGUAGE TypeFamilies #-}
11−{-# LANGUAGE TypeOperators #-}
15+{-# LANGUAGE TypeOperators #-}
12−{-# LANGUAGE UndecidableInstances #-}
16+{-# LANGUAGE UndecidableInstances #-}
13−{-# LANGUAGE MultiParamTypeClasses #-}
17+
18+#if MIN_VERSION_base(4,9,0)
19+{-# OPTIONS_GHC -fno-warn-redundant-constraints #-}
15-- #include "overlapping-compat.h"
22-- #include "overlapping-compat.h"
16-- | This module provides 'client' which can automatically generate
23-- | This module provides 'client' which can automatically generate
@@ -18,30 +25,71 @@
19module Servant.Reflex
26module Servant.Reflex
21− , HasClient(..)
28+ , clientWithOpts
29+ , clientWithOptsAndResultHandler
31+ , clientWithRouteAndResultHandler
32+ , BuildHeaderKeysTo(..)
36+ , module Servant.Common.Req
22 , module Servant.Common.BaseUrl
37 , module Servant.Common.BaseUrl
40+------------------------------------------------------------------------------
25−import Control.Applicative ((<$>))
41+import Control.Applicative
26−import Control.Monad.Trans.Except
27−import qualified Data.ByteString.Char8 as BS
28−import Data.ByteString.Lazy (ByteString)
29−import qualified Data.CaseInsensitive as CI
42+import qualified Data.CaseInsensitive as CI
30−import Data.List
43+import Data.Functor.Identity
31−import Data.Proxy
44+import qualified Data.Map as Map
32−import Data.String.Conversions
45+import Data.Monoid ((<>))
33−import Data.Maybe (maybeToList)
46+import Data.Proxy (Proxy (..))
47+import qualified Data.Set as Set
34−import Data.Text (unpack)
48+import Data.Text (Text)
35−import Data.Traversable (sequenceA)
49+import qualified Data.Text as T
50+import qualified Data.Text.Encoding as E
51+import GHC.Exts (Constraint)
36−import GHC.TypeLits
52+import GHC.TypeLits (KnownSymbol, symbolVal)
37−import qualified Network.HTTP.Media as M
53+import Servant.API ((:<|>) (..), (:>), BasicAuth,
38−import Servant.API
54+ BasicAuthData, BuildHeadersTo (..),
55+ Capture, Header, Headers (..),
56+ HttpVersion, IsSecure,
57+ MimeRender (..), MimeUnrender,
58+ NoContent, QueryFlag, QueryParam,
59+ QueryParams, Raw, ReflectMethod (..),
61+ ToHttpApiData (..), Vault, Verb,
63+import Servant.API.Description (Summary)
64+import qualified Servant.Auth as Auth
66+import Reflex.Dom.Core (Dynamic, Event, Reflex,
67+ XhrRequest (..), XhrResponse (..),
68+ XhrResponseHeaders (..),
69+ attachPromptlyDynWith, constDyn, ffor,
71+ performRequestsAsync)
72+------------------------------------------------------------------------------
39−import Servant.Common.BaseUrl
73+import Servant.Common.BaseUrl (BaseUrl(..), Scheme(..), baseUrlWidget,
75+ SupportsServantReflex)
40−import Servant.Common.Req
76+import Servant.Common.Req (ClientOptions(..),
41−import Servant.API.ContentTypes
77+ defaultClientOptions,
42−import Reflex
78+ Req, ReqResult(..), QParam(..),
43−import Reflex.Dom
79+ QueryPart(..), addHeader, authData,
44−import Reflex.Dom.Xhr
80+ defReq, evalResponse, prependToPathParts,
83+ -- performRequestNoBody,
84+ performRequestsNoBody,
85+ performSomeRequestsAsync,
86+ qParamToQueryPart, reqBody,
87+ reqSuccess, reqFailure,
88+ reqMethod, respHeaders,
91+ qParams, withCredentials)
46-- * Accessing APIs as a Client
94-- * Accessing APIs as a Client
@@ -53,116 +101,191 @@ import Reflex.Dom.Xhr
53-- > myApi :: Proxy MyApi
101-- > myApi :: Proxy MyApi
54-- > myApi = Proxy
102-- > myApi = Proxy
56−-- > getAllBooks :: Event t () -> m (Event t (Either XhrError ((),[Book])))
104+-- > getAllBooks :: Event t l -> m (Event t (l, ReqResult [Book]))
57−-- > postNewBook :: Behavior t (Maybe Book) -> Event t ()
105+-- > postNewBook :: Dynamic t (Maybe Book) -> Event t l
58−-- -> m (Event t (Either XhrError (Book,Book)))
106+-- > -> m (Event t (l, ReqResult Book)))
59-- > (getAllBooks :<|> postNewBook) = client myApi host
107-- > (getAllBooks :<|> postNewBook) = client myApi host
60-- > where host = constDyn $ BaseUrl Http "localhost" 8080
108-- > where host = constDyn $ BaseUrl Http "localhost" 8080
61−client :: (HasClient t m layout, MonadWidget t m)
110+ :: (HasClient t m layout tag)
114+ -> Dynamic t BaseUrl
115+ -> Client t m layout tag
116+client p q t baseurl = clientWithRoute p q t defReq baseurl defaultClientOptions
119+ :: (HasClient t m layout tag)
62− => Proxy layout -> Proxy m -> Dynamic t BaseUrl -> Client t m layout
123+ -> Dynamic t BaseUrl
125+ -> Client t m layout tag
63−client p q baseurl = clientWithRoute p q defReq baseurl
126+clientWithOpts p q t baseurl = clientWithRoute p q t defReq baseurl
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)
136+ -> Dynamic t BaseUrl
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
65-- | This class lets us define how each API combinator
143-- | This class lets us define how each API combinator
66-- influences the creation of an HTTP request. It's mostly
144-- influences the creation of an HTTP request. It's mostly
67-- an internal class, you can just use 'client'.
145-- an internal class, you can just use 'client'.
68−class HasClient t m layout where
146+class Monad m => HasClient t m layout (tag :: *) where
69− type Client t m layout :: *
147+ type Client t m layout tag :: *
70− clientWithRoute :: Proxy layout -> Proxy m -> Req t -> Dynamic t BaseUrl -> Client t m layout
148+ clientWithRoute
153+ -> Dynamic t BaseUrl
155+ -> Client t m layout tag
156+ clientWithRoute l m t r b o = clientWithRouteAndResultHandler l m t r b o return
158+ clientWithRouteAndResultHandler
163+ -> Dynamic t BaseUrl
165+ -> (forall a. Event t (ReqResult tag a) -> m (Event t (ReqResult tag a)))
166+ -> Client t m layout tag
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
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
73−instance (HasClient t m a, HasClient t m b) => HasClient t m (a :<|> b) where
74− type Client t m (a :<|> b) = Client t m a :<|> Client t m b
75− clientWithRoute Proxy q req baseurl =
76− clientWithRoute (Proxy :: Proxy a) q req baseurl :<|>
77− clientWithRoute (Proxy :: Proxy b) q req baseurl
79-- Capture. Example:
177-- Capture. Example:
80-- > type MyApi = "books" :> Capture "isbn" Text :> Get '[JSON] Book
178-- > type MyApi = "books" :> Capture "isbn" Text :> Get '[JSON] Book
82-- > myApi :: Proxy MyApi = Proxy
180-- > myApi :: Proxy MyApi = Proxy
84−-- > getBook :: MonadWidget t m
182+-- > getBook :: SupportsServantReflex t m
85-- => Dynamic t BaseUrl
183-- => Dynamic t BaseUrl
86−-- -> Behavior t (Maybe Text)
184+-- -> Dynamic t (Maybe Text)
87−-- -> Event t ()
185+-- -> Event t l
88−-- -> m (Event t (Either XhrError (Text, Book)))
186+-- -> m (Event t (l, ReqResult Book))
89-- > getBook = client myApi (constDyn host)
187-- > getBook = client myApi (constDyn host)
90−instance (MonadWidget t m, KnownSymbol capture, ToHttpApiData a, HasClient t m sublayout)
91− => HasClient t m (Capture capture a :> sublayout) where
189+instance (SupportsServantReflex t m, ToHttpApiData a, HasClient t m sublayout tag)
190+ => HasClient t m (Capture capture a :> sublayout) tag where
93− type Client t m (Capture capture a :> sublayout) =
192+ type Client t m (Capture capture a :> sublayout) tag =
94− Behavior t (Maybe a) -> Client t m sublayout
193+ Dynamic t (Either Text a) -> Client t m sublayout tag
96− clientWithRoute Proxy q req baseurl val =
195+ clientWithRouteAndResultHandler Proxy q t req baseurl opts wrap val =
97− clientWithRoute (Proxy :: Proxy sublayout)
196+ clientWithRouteAndResultHandler
99− (prependToPathParts p req)
197+ (Proxy :: Proxy sublayout) q t (prependToPathParts p req) baseurl opts wrap
100− baseurl
198+ where p = (fmap . fmap) (toUrlPiece) val
102− where p = (fmap . fmap) (unpack . toUrlPiece) val
104-- VERB (Returning content) --
201-- VERB (Returning content) --
105instance {-# OVERLAPPABLE #-}
202instance {-# OVERLAPPABLE #-}
106 -- Note [Non-Empty Content Types]
203 -- Note [Non-Empty Content Types]
107− (MimeUnrender ct a, ReflectMethod method, cts' ~ (ct ': cts), MonadWidget t m
204+ (MimeUnrender ct a, ReflectMethod method, cts' ~ (ct ': cts), SupportsServantReflex t m
108− ) => HasClient t m (Verb method status cts' a) where
205+ ) => HasClient t m (Verb method status cts' a) tag where
109− type Client t m (Verb method status cts' a) =
206+ type Client t m (Verb method status cts' a) tag =
110− Event t () -> m (Event t (Maybe a, XhrResponse))
207+ Event t tag -> m (Event t (ReqResult tag a))
111 -- TODO how to access input types here?
208 -- TODO how to access input types here?
112 -- ExceptT ServantError IO a
209 -- ExceptT ServantError IO a
113− clientWithRoute Proxy q req baseurl =
210+ clientWithRouteAndResultHandler Proxy _ _ req baseurl opts wrap trigs =
114− performRequestCT (Proxy :: Proxy ct) method req' baseurl
211+ wrap =<< fmap runIdentity <$> performRequestsCT (Proxy :: Proxy ct) method (constDyn $ Identity $ req') baseurl opts trigs
115− where method = BS.unpack $ reflectMethod (Proxy :: Proxy method)
212+ where method = E.decodeUtf8 $ reflectMethod (Proxy :: Proxy method)
116 req' = req { reqMethod = method }
213 req' = req { reqMethod = method }
118-- -- VERB (No content) --
216-- -- VERB (No content) --
119instance {-# OVERLAPPING #-}
217instance {-# OVERLAPPING #-}
120− (ReflectMethod method, MonadWidget t m) =>
218+ (ReflectMethod method, SupportsServantReflex t m) =>
121− HasClient t m (Verb method status cts NoContent) where
219+ HasClient t m (Verb method status cts NoContent) tag where
122− type Client t m (Verb method status cts NoContent) =
220+ type Client t m (Verb method status cts NoContent) tag =
123− Event t () -> m (Event t (Maybe NoContent, XhrResponse))
221+ Event t tag -> m (Event t (ReqResult tag NoContent))
124 -- TODO: how to access input types here?
222 -- TODO: how to access input types here?
125 -- ExceptT ServantError IO NoContent
223 -- ExceptT ServantError IO NoContent
126− clientWithRoute Proxy q req baseurl =
224+ clientWithRouteAndResultHandler Proxy _ _ req baseurl opts wrap trigs =
127− performRequestNoBody method req baseurl
225+ wrap =<< fmap runIdentity <$> performRequestsNoBody method (constDyn $ Identity req) baseurl opts trigs
128− where method = BS.unpack $ reflectMethod (Proxy :: Proxy method)
226+ where method = E.decodeUtf8 $ reflectMethod (Proxy :: Proxy method)
130−-- -- HEADERS Verb (Content) --
228+
131−-- -- Headers combinator not treated in fully general case,
229+toHeaders :: BuildHeadersTo ls => ReqResult tag a -> ReqResult tag (Headers ls a)
132−-- -- in order to deny instances for (Headers ls (Capture "id" Int)),
230+toHeaders r =
133−-- -- a combinator that wouldn't make sense
231+ let hdrs = maybe []
134−-- -- TODO Overlapping??
232+ (\xhr -> fmap (\(h,v) -> (CI.map E.encodeUtf8 h, E.encodeUtf8 v))
135−-- instance {-# OVERLAPPABLE #-}
233+ (Map.toList $ _xhrResponse_headers xhr))
136−-- -- Note [Non-Empty Content Types]
234+ (response r)
137−-- ( MimeUnrender ct a, BuildHeadersTo ls,
138−-- ReflectMethod method, cts' ~ (ct ': cts),
140−-- ) => HasClient t m (Verb method status cts' (Headers ls a)) where
141−-- type Client t m (Verb method status cts' (Headers ls a))
142−-- = Event t () -> m (Event t (Maybe a, XhrResponse))
143−-- -- ExceptT ServantError IO (Headers ls a)
144−-- clientWithRoute Proxy req baseurl = do
145−-- let method = reflectMethod (Proxy :: Proxy method)
146−-- (hdrs, resp) <- performRequestCT (Proxy :: Proxy ct) method req baseurl
147−-- return $ Headers { getResponse = resp
148−-- , getHeadersHList = buildHeadersTo hdrs
235+ in ffor r $ \a -> Headers {getResponse = a ,getHeadersHList = buildHeadersTo hdrs}
238+class BuildHeaderKeysTo hs where
239+ buildHeaderKeysTo :: Proxy hs -> [CI.CI T.Text]
241+instance {-# OVERLAPPABLE #-} BuildHeaderKeysTo '[]
242+ where buildHeaderKeysTo _ = []
244+instance {-# OVERLAPPABLE #-} (BuildHeaderKeysTo xs, KnownSymbol h)
245+ => BuildHeaderKeysTo ((Header h v) ': xs) where
246+ buildHeaderKeysTo _ =
248+ thisKey = CI.mk $ T.pack (symbolVal (Proxy :: Proxy h))
249+ in thisKey : buildHeaderKeysTo (Proxy :: Proxy xs)
252+-- HEADERS Verb (Content) --
253+-- Headers combinator not treated in fully general case,
254+-- in order to deny instances for (Headers ls (Capture "id" Int)),
255+-- a combinator that wouldn't make sense
151-- TODO Overlapping??
256-- TODO Overlapping??
257+instance {-# OVERLAPPABLE #-}
258+ -- Note [Non-Empty Content Types]
259+ ( MimeUnrender ct a, BuildHeadersTo ls, BuildHeaderKeysTo ls,
260+ 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
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)))
152−-- -- HEADERS Verb (No content) --
274+-- HEADERS Verb (No content) --
153−-- instance {-# OVERLAPPABLE #-}
275+instance {-# OVERLAPPABLE #-}
154−-- ( BuildHeadersTo ls, ReflectMethod method,
276+ ( BuildHeadersTo ls, BuildHeaderKeysTo ls, ReflectMethod method,
155−-- MonadWidget t m
277+ SupportsServantReflex t m
156−-- ) => HasClient t m (Verb method status cts (Headers ls NoContent)) where
278+ ) => HasClient t m (Verb method status cts (Headers ls NoContent)) tag where
157−-- type Client t m (Verb method status cts (Headers ls NoContent))
279+ type Client t m (Verb method status cts (Headers ls NoContent)) tag
158−-- = Event t () -> m (Event t XhrResponse)
159−-- -- ExceptT ServantError IO (Headers ls NoContent)
280+ = Event t tag -> m (Event t (ReqResult tag (Headers ls NoContent)))
160−-- clientWithRoute Proxy req baseurl = do
281+ clientWithRouteAndResultHandler Proxy _ _ req baseurl opts wrap trigs = do
161−-- let method = reflectMethod (Proxy :: Proxy method)
282+ let method = E.decodeUtf8 $ reflectMethod (Proxy :: Proxy method)
162−-- hdrs <- performRequestNoBody method req baseurl
283+ resp <- fmap runIdentity <$> performRequestsNoBody method (constDyn $ Identity req') baseurl opts trigs
163−-- return $ Headers { getResponse = NoContent
284+ wrap $ toHeaders <$> resp
164−-- , getHeadersHList = buildHeadersTo hdrs
285+ where req' = req {respHeaders =
286+ OnlyHeaders (Set.fromList (buildHeaderKeysTo (Proxy :: Proxy ls)))
@@ -179,34 +302,46 @@ instance {-# OVERLAPPING #-}
179-- > -- then you can just use "viewRefer" to query that endpoint
302-- > -- then you can just use "viewRefer" to query that endpoint
180-- > -- specifying Nothing or e.g Just "http://haskell.org/" as arguments
303-- > -- specifying Nothing or e.g Just "http://haskell.org/" as arguments
181instance (KnownSymbol sym, ToHttpApiData a,
304instance (KnownSymbol sym, ToHttpApiData a,
182− HasClient t m sublayout, MonadWidget t m)
305+ HasClient t m sublayout tag, SupportsServantReflex t m)
183− => HasClient t m (Header sym a :> sublayout) where
306+ => HasClient t m (Header sym a :> sublayout) tag where
308+ type Client t m (Header sym a :> sublayout) tag =
309+ Dynamic t (Either Text a) -> Client t m sublayout tag
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)
316+ where hname = T.pack $ symbolVal (Proxy :: Proxy sym)
185− type Client t m (Header sym a :> sublayout) =
186− Behavior t (Maybe a) -> Client t m sublayout
188− clientWithRoute Proxy q req baseurl mval =
189− clientWithRoute (Proxy :: Proxy sublayout)
192− -- (maybe req -- TODO Need to pass the header in
193− -- (\value -> Servant.Common.Req.addHeader hname value req)
198− where hname = symbolVal (Proxy :: Proxy sym)
200-- | Using a 'HttpVersion' combinator in your API doesn't affect the client
321-- | Using a 'HttpVersion' combinator in your API doesn't affect the client
201-- functions.
322-- functions.
202−instance HasClient t m sublayout
323+instance HasClient t m sublayout tag
203− => HasClient t m (HttpVersion :> sublayout) where
324+ => HasClient t m (HttpVersion :> sublayout) tag where
326+ type Client t m (HttpVersion :> sublayout) tag =
327+ Client t m sublayout tag
329+ clientWithRouteAndResultHandler Proxy =
330+ clientWithRouteAndResultHandler (Proxy :: Proxy sublayout)
332+-- | Using a 'Summary' combinator in your API doesn't affect the client
334+instance (HasClient t m sublayout tag, KnownSymbol sym)
335+ => HasClient t m (Summary sym :> sublayout) tag where
337+ type Client t m (Summary sym :> sublayout) tag =
338+ Client t m sublayout tag
340+ clientWithRouteAndResultHandler Proxy =
341+ clientWithRouteAndResultHandler (Proxy :: Proxy sublayout)
205− type Client t m (HttpVersion :> sublayout) =
206− Client t m sublayout
208− clientWithRoute Proxy q =
209− clientWithRoute (Proxy :: Proxy sublayout) q
211-- | If you use a 'QueryParam' in one of your endpoints in your API,
346-- | If you use a 'QueryParam' in one of your endpoints in your API,
212-- the corresponding querying function will automatically take
347-- the corresponding querying function will automatically take
@@ -234,21 +369,24 @@ instance HasClient t m sublayout
234-- > -- then you can just use "getBooksBy" to query that endpoint.
369-- > -- then you can just use "getBooksBy" to query that endpoint.
235-- > -- 'getBooksBy Nothing' for all books
370-- > -- 'getBooksBy Nothing' for all books
236-- > -- 'getBooksBy (Just "Isaac Asimov")' to get all books by Isaac Asimov
371-- > -- 'getBooksBy (Just "Isaac Asimov")' to get all books by Isaac Asimov
237−instance (KnownSymbol sym, ToHttpApiData a, HasClient t m sublayout, Reflex t)
372+instance (KnownSymbol sym, ToHttpApiData a, HasClient t m sublayout tag, Reflex t)
238− => HasClient t m (QueryParam sym a :> sublayout) where
373+ => HasClient t m (QueryParam sym a :> sublayout) tag where
240− type Client t m (QueryParam sym a :> sublayout) =
375+ type Client t m (QueryParam sym a :> sublayout) tag =
241− -- TODO (Maybe a), or (Maybe (Maybe a))? (should the user be able to send a Nothing)
242− Behavior t (Maybe a) -> Client t m sublayout
376+ Dynamic t (QParam a) -> Client t m sublayout tag
244 -- if mparam = Nothing, we don't add it to the query string
378 -- if mparam = Nothing, we don't add it to the query string
245− clientWithRoute Proxy q req baseurl mparam =
379+ clientWithRouteAndResultHandler Proxy q t req baseurl opts wrap mparam =
246− clientWithRoute (Proxy :: Proxy sublayout) q
380+ clientWithRouteAndResultHandler (Proxy :: Proxy sublayout) q t
247− (req {qParams = paramPair : qParams req}) baseurl
381+ (req {qParams = paramPair : qParams req}) baseurl opts wrap
249 where pname = symbolVal (Proxy :: Proxy sym)
383 where pname = symbolVal (Proxy :: Proxy sym)
384+ --p prm = QueryPartParam $ (fmap . fmap) (toQueryParam) prm
385+ --paramPair = (T.pack pname, p mparam)
250− p prm = QueryPartParam $ fmap maybeToList $ (fmap . fmap) (unpack . toQueryParam) prm
386+ p prm = QueryPartParam $ fmap qParamToQueryPart prm -- (fmap . fmap) (unpack . toQueryParam) prm
251− paramPair = (pname, p mparam)
387+ paramPair = (T.pack pname, p mparam)
253-- | If you use a 'QueryParams' in one of your endpoints in your API,
391-- | If you use a 'QueryParams' in one of your endpoints in your API,
254-- the corresponding querying function will automatically take
392-- the corresponding querying function will automatically take
@@ -278,21 +416,22 @@ instance (KnownSymbol sym, ToHttpApiData a, HasClient t m sublayout, Reflex t)
278-- > -- 'getBooksBy []' for all books
416-- > -- 'getBooksBy []' for all books
279-- > -- 'getBooksBy ["Isaac Asimov", "Robert A. Heinlein"]'
417-- > -- 'getBooksBy ["Isaac Asimov", "Robert A. Heinlein"]'
280-- > -- to get all books by Asimov and Heinlein
418-- > -- to get all books by Asimov and Heinlein
281−instance (KnownSymbol sym, ToHttpApiData a, HasClient t m sublayout, Reflex t)
419+instance (KnownSymbol sym, ToHttpApiData a, HasClient t m sublayout tag, Reflex t)
282− => HasClient t m (QueryParams sym a :> sublayout) where
420+ => HasClient t m (QueryParams sym a :> sublayout) tag where
284− type Client t m (QueryParams sym a :> sublayout) =
422+ type Client t m (QueryParams sym a :> sublayout) tag =
285− Behavior t [a] -> Client t m sublayout
423+ Dynamic t [a] -> Client t m sublayout tag
287− clientWithRoute Proxy q req baseurl paramlist =
425+ clientWithRouteAndResultHandler Proxy q t req baseurl opts wrap paramlist =
288− clientWithRoute (Proxy :: Proxy sublayout) q req' baseurl
426+ clientWithRouteAndResultHandler (Proxy :: Proxy sublayout) q t req' baseurl opts wrap
290− where req' = req { qParams = (pname, params') : qParams req }
428+ where req' = req { qParams = (T.pack pname, params') : qParams req }
291 pname = symbolVal (Proxy :: Proxy sym)
429 pname = symbolVal (Proxy :: Proxy sym)
292− params' = QueryPartParam $ (fmap . fmap) (unpack . toQueryParam)
430+ params' = QueryPartParams $ (fmap . fmap) toQueryParam
293 paramlist
431 paramlist
296-- | If you use a 'QueryFlag' in one of your endpoints in your API,
435-- | If you use a 'QueryFlag' in one of your endpoints in your API,
297-- the corresponding querying function will automatically take
436-- the corresponding querying function will automatically take
298-- an additional 'Bool' argument.
437-- an additional 'Bool' argument.
@@ -317,32 +456,42 @@ instance (KnownSymbol sym, ToHttpApiData a, HasClient t m sublayout, Reflex t)
317-- > -- 'getBooksBy True' to only get _already published_ books
456-- > -- 'getBooksBy True' to only get _already published_ books
319-- TODO Bring back
458-- TODO Bring back
320−instance (KnownSymbol sym, HasClient t m sublayout, Reflex t)
459+instance (KnownSymbol sym, HasClient t m sublayout tag, Reflex t)
321− => HasClient t m (QueryFlag sym :> sublayout) where
460+ => HasClient t m (QueryFlag sym :> sublayout) tag where
323− type Client t m (QueryFlag sym :> sublayout) =
462+ type Client t m (QueryFlag sym :> sublayout) tag =
324− Behavior t Bool -> Client t m sublayout
463+ Dynamic t Bool -> Client t m sublayout tag
326− clientWithRoute Proxy q req baseurl flag =
465+ clientWithRouteAndResultHandler Proxy q t req baseurl opts wrap flag =
327− clientWithRoute (Proxy :: Proxy sublayout) q req' baseurl
466+ clientWithRouteAndResultHandler (Proxy :: Proxy sublayout) q t req' baseurl opts wrap
329 where req' = req { qParams = thisPair : qParams req }
468 where req' = req { qParams = thisPair : qParams req }
330− thisPair = (pName, QueryPartFlag flag) :: (String, QueryPart t)
469+ thisPair = (T.pack pName, QueryPartFlag flag) :: (Text, QueryPart t)
331 pName = symbolVal (Proxy :: Proxy sym)
470 pName = symbolVal (Proxy :: Proxy sym)
334−-- | Pick a 'Method' and specify where the server you want to query is. You get
335−-- back the full `Response`.
337−instance (MonadWidget t m) => HasClient t m Raw where
338− type Client t m Raw = Behavior t (Maybe XhrRequest)
340− -> m (Event t XhrResponse)
342− -- clientWithRoute :: Proxy Raw -> Proxy m -> Req -> BaseUrl -> Client t m Raw
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 ()))
478+ -> m (Event t (ReqResult tag ()))
343− clientWithRoute p q req baseurl xhrs triggers = do
480+ clientWithRouteAndResultHandler _ _ _ _ baseurl _ wrap xhrs triggers = do
344− let okReq = fmapMaybe id $ tag xhrs triggers
481+
345− performRequestAsync okReq
482+ let xhrs' = liftA2 (\x path -> case x of
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 ())
490+ resps <- performRequestsAsync okReq
491+ wrap $ leftmost [ uncurry RequestFailure <$> badReq
492+ , evalResponse (const $ Right ()) <$> resps
347-- | If you use a 'ReqBody' in one of your endpoints in your API,
496-- | If you use a 'ReqBody' in one of your endpoints in your API,
348-- the corresponding querying function will automatically take
497-- the corresponding querying function will automatically take
@@ -364,56 +513,72 @@ instance (MonadWidget t m) => HasClient t m Raw where
364-- > where host = BaseUrl Http "localhost" 8080
513-- > where host = BaseUrl Http "localhost" 8080
365-- > -- then you can just use "addBook" to query that endpoint
514-- > -- then you can just use "addBook" to query that endpoint
367−instance (MimeRender ct a, HasClient t m sublayout, Reflex t)
516+instance (MimeRender ct a, HasClient t m sublayout tag, Reflex t)
368− => HasClient t m (ReqBody (ct ': cts) a :> sublayout) where
517+ => HasClient t m (ReqBody (ct ': cts) a :> sublayout) tag where
370− type Client t m (ReqBody (ct ': cts) a :> sublayout) =
519+ type Client t m (ReqBody (ct ': cts) a :> sublayout) tag =
371− Behavior t (Maybe a) -> Client t m sublayout
520+ Dynamic t (Either Text a) -> Client t m sublayout tag
373− clientWithRoute Proxy q req baseurl body =
522+ clientWithRouteAndResultHandler Proxy q t req baseurl opts wrap body =
374− clientWithRoute (Proxy :: Proxy sublayout) q req' baseurl
523+ clientWithRouteAndResultHandler (Proxy :: Proxy sublayout) q t req' baseurl opts wrap
375 where req' = req { reqBody = bodyBytesCT }
524 where req' = req { reqBody = bodyBytesCT }
376 ctProxy = Proxy :: Proxy ct
525 ctProxy = Proxy :: Proxy ct
377− ctString = show $ contentType ctProxy
526+ ctString = T.pack $ show $ contentType ctProxy
378− --ctString = BS.unpack . CI.original . M.mainType $ contentType ctProxy
379 bodyBytesCT = Just $ (fmap . fmap)
527 bodyBytesCT = Just $ (fmap . fmap)
380 (\b -> (mimeRender ctProxy b, ctString))
528 (\b -> (mimeRender ctProxy b, ctString))
383-- | Make the querying function append @path@ to the request path.
533-- | Make the querying function append @path@ to the request path.
384−instance (KnownSymbol path, HasClient t m sublayout, Reflex t) => HasClient t m (path :> sublayout) where
534+instance (KnownSymbol path, HasClient t m sublayout tag, Reflex t) => HasClient t m (path :> sublayout) tag where
385− type Client t m (path :> sublayout) = Client t m sublayout
535+ type Client t m (path :> sublayout) tag = Client t m sublayout tag
387− clientWithRoute Proxy q req baseurl =
537+ clientWithRouteAndResultHandler Proxy q t req baseurl opts wrap =
388− clientWithRoute (Proxy :: Proxy sublayout) q
538+ clientWithRouteAndResultHandler (Proxy :: Proxy sublayout) q t
389− (prependToPathParts (constant (Just p)) req)
539+ (prependToPathParts (pure (Right $ T.pack p)) req) baseurl opts wrap
392 where p = symbolVal (Proxy :: Proxy path)
541 where p = symbolVal (Proxy :: Proxy path)
394−instance HasClient t m api => HasClient t m (Vault :> api) where
395− type Client t m (Vault :> api) = Client t m api
397− clientWithRoute Proxy q req baseurl =
544+instance HasClient t m api tag => HasClient t m (Vault :> api) tag where
398− clientWithRoute (Proxy :: Proxy api) q req baseurl
545+ type Client t m (Vault :> api) tag = Client t m api tag
547+ clientWithRouteAndResultHandler Proxy =
548+ clientWithRouteAndResultHandler (Proxy :: Proxy 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
554+ clientWithRouteAndResultHandler Proxy =
555+ clientWithRouteAndResultHandler (Proxy :: Proxy api)
400−instance HasClient t m api => HasClient t m (RemoteHost :> api) where
401− type Client t m (RemoteHost :> api) = Client t m api
403− clientWithRoute Proxy q req baseurl =
559+instance HasClient t m api tag => HasClient t m (IsSecure :> api) tag where
404− clientWithRoute (Proxy :: Proxy api) q req baseurl
560+ type Client t m (IsSecure :> api) tag = Client t m api tag
406−instance HasClient t m api => HasClient t m (IsSecure :> api) where
562+ clientWithRouteAndResultHandler Proxy =
407− type Client t m (IsSecure :> api) = Client t m api
563+ clientWithRouteAndResultHandler (Proxy :: Proxy api)
409− clientWithRoute Proxy q req baseurl =
410− clientWithRoute (Proxy :: Proxy api) q req baseurl
412−instance HasClient t m subapi =>
566+instance (HasClient t m api tag, Reflex t)
413− HasClient t m (WithNamedContext name config subapi) where
567+ => HasClient t m (BasicAuth realm usr :> api) tag where
569+ type Client t m (BasicAuth realm usr :> api) tag = Dynamic t (Maybe BasicAuthData)
570+ -> Client t m api tag
572+ clientWithRouteAndResultHandler Proxy q t req baseurl opts wrap authdata =
573+ clientWithRouteAndResultHandler (Proxy :: Proxy api) q t req' baseurl opts wrap
575+ req' = req { authData = Just authdata }
577+-- instance HasClient t m subapi =>
578+-- HasClient t m (WithNamedConfig name config subapi) where
415− type Client t m (WithNamedContext name config subapi) = Client t m subapi
580+-- type Client t m (WithNamedConfig name config subapi) = Client t m subapi
416− clientWithRoute Proxy q = clientWithRoute (Proxy :: Proxy subapi) q
581+-- clientWithRoute Proxy q = clientWithRoute (Proxy :: Proxy subapi) q
419{- Note [Non-Empty Content Types]
584{- Note [Non-Empty Content Types]
@@ -431,3 +596,30 @@ non-empty lists, but is otherwise more specific, no instance will be overall
431more specific. This in turn generally means adding yet another instance (one
596more specific. This in turn generally means adding yet another instance (one
432for empty and one for non-empty lists).
597for empty and one for non-empty lists).
601+-- SUPPORT FOR servant-auth --
603+-- For JavaScript clients we should be sending/storing JSON web tokens in a
604+-- way that is inaccessible to JavaScript.
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
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
615+ type Client t m (Auth.Auth auths a :> api) tag = Client t m api tag
616+ clientWithRouteAndResultHandler Proxy = clientWithRouteAndResultHandler (Proxy :: Proxy api)
619+type family HasCookieAuth xs :: Constraint where
620+ HasCookieAuth (Auth.Cookie ': xs) = ()
621+ HasCookieAuth (x ': xs) = HasCookieAuth xs
622+ HasCookieAuth '[] = CookieAuthNotEnabled
624+class CookieAuthNotEnabled