@@ -1,23 +1,16 @@
1−{-# LANGUAGE AllowAmbiguousTypes #-}
1+{-# LANGUAGE CPP #-}
3−{-# LANGUAGE DataKinds #-}
2+{-# LANGUAGE DataKinds #-}
4−{-# LANGUAGE FlexibleContexts #-}
3+{-# LANGUAGE FlexibleContexts #-}
5−{-# LANGUAGE FlexibleInstances #-}
4+{-# LANGUAGE FlexibleInstances #-}
6−{-# LANGUAGE GeneralizedNewtypeDeriving #-}
7−{-# LANGUAGE InstanceSigs #-}
5+{-# LANGUAGE InstanceSigs #-}
8−{-# LANGUAGE MultiParamTypeClasses #-}
9−{-# LANGUAGE OverloadedStrings #-}
6+{-# LANGUAGE OverloadedStrings #-}
10−{-# LANGUAGE PolyKinds #-}
7+{-# LANGUAGE PolyKinds #-}
11−{-# LANGUAGE Rank2Types #-}
12−{-# LANGUAGE ScopedTypeVariables #-}
8+{-# LANGUAGE ScopedTypeVariables #-}
13−{-# LANGUAGE TupleSections #-}
9+{-# LANGUAGE TupleSections #-}
14−{-# LANGUAGE TypeFamilies #-}
10+{-# LANGUAGE TypeFamilies #-}
15−{-# LANGUAGE TypeOperators #-}
11+{-# LANGUAGE TypeOperators #-}
16−{-# LANGUAGE UndecidableInstances #-}
12+{-# LANGUAGE UndecidableInstances #-}
17−
13+{-# LANGUAGE MultiParamTypeClasses #-}
18−#if MIN_VERSION_base(4,9,0)
19−{-# OPTIONS_GHC -fno-warn-redundant-constraints #-}
22-- #include "overlapping-compat.h"
15-- #include "overlapping-compat.h"
23-- | This module provides 'client' which can automatically generate
16-- | This module provides 'client' which can automatically generate
@@ -25,71 +18,23 @@
26module Servant.Reflex
19module Servant.Reflex
28− , clientWithOpts
21+ , HasClient(..)
29− , clientWithOptsAndResultHandler
31− , clientWithRouteAndResultHandler
32− , BuildHeaderKeysTo(..)
36 , module Servant.Common.Req
22 , module Servant.Common.Req
37 , module Servant.Common.BaseUrl
23 , module Servant.Common.BaseUrl
40−------------------------------------------------------------------------------
41import Control.Applicative
26import Control.Applicative
42−import qualified Data.CaseInsensitive as CI
27+import Data.Proxy
43−import Data.Functor.Identity
44−import qualified Data.Map as Map
45−import Data.Monoid ((<>))
46−import Data.Proxy (Proxy (..))
28+import Data.String.Conversions
47−import qualified Data.Set as Set
48−import Data.Text (Text)
29+import Data.Text (Text)
49−import qualified Data.Text as T
30+import qualified Data.Text as T
50−import qualified Data.Text.Encoding as E
31+import Data.Text.Encoding
51−import GHC.Exts (Constraint)
52−import GHC.TypeLits (KnownSymbol, symbolVal)
32+import GHC.TypeLits
53−import Servant.API ((:<|>) (..), (:>), BasicAuth,
33+import Servant.API
54− BasicAuthData, BuildHeadersTo (..),
34+import Servant.Common.BaseUrl
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)
35+import Servant.Common.Req
64−import qualified Servant.Auth as Auth
36+import Reflex
66−import Reflex.Dom.Core (Dynamic, Event, Reflex,
37+import Reflex.Dom
67− XhrRequest (..), XhrResponse (..),
68− XhrResponseHeaders (..),
69− attachPromptlyDynWith, constDyn, ffor,
71− performRequestsAsync)
72−------------------------------------------------------------------------------
73−import Servant.Common.BaseUrl (BaseUrl(..), Scheme(..), baseUrlWidget,
75− SupportsServantReflex)
76−import Servant.Common.Req (ClientOptions(..),
77− defaultClientOptions,
78− Req, ReqResult(..), QParam(..),
79− QueryPart(..), addHeader, authData,
80− defReq, evalResponse, prependToPathParts,
83− -- performRequestNoBody,
84− performRequestsNoBody,
85− performSomeRequestsAsync,
86− qParamToQueryPart, reqBody,
87− reqSuccess, reqFailure,
88− reqMethod, respHeaders,
91− qParams, withCredentials)
94-- * Accessing APIs as a Client
39-- * Accessing APIs as a Client
@@ -101,191 +46,116 @@ import Servant.Common.Req (ClientOptions(..),
101-- > myApi :: Proxy MyApi
46-- > myApi :: Proxy MyApi
102-- > myApi = Proxy
47-- > myApi = Proxy
104−-- > getAllBooks :: Event t l -> m (Event t (l, ReqResult [Book]))
49+-- > getAllBooks :: Event t () -> m (Event t (Either XhrError ((),[Book])))
105−-- > postNewBook :: Dynamic t (Maybe Book) -> Event t l
50+-- > postNewBook :: Dynamic t (Maybe Book) -> Event t ()
106−-- > -> m (Event t (l, ReqResult Book)))
51+-- -> m (Event t (Either XhrError (Book,Book)))
107-- > (getAllBooks :<|> postNewBook) = client myApi host
52-- > (getAllBooks :<|> postNewBook) = client myApi host
108-- > where host = constDyn $ BaseUrl Http "localhost" 8080
53-- > where host = constDyn $ BaseUrl Http "localhost" 8080
109−client
54+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)
123− -> Dynamic t BaseUrl
55+ => Proxy layout -> Proxy m -> Dynamic t BaseUrl -> Client t m layout
125− -> Client t m layout tag
126−clientWithOpts p q t baseurl = clientWithRoute p q t defReq baseurl
56+client p q baseurl = clientWithRoute p q 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
143-- | This class lets us define how each API combinator
58-- | This class lets us define how each API combinator
144-- influences the creation of an HTTP request. It's mostly
59-- influences the creation of an HTTP request. It's mostly
145-- an internal class, you can just use 'client'.
60-- an internal class, you can just use 'client'.
146−class Monad m => HasClient t m layout (tag :: *) where
61+class HasClient t m layout where
147− type Client t m layout tag :: *
62+ type Client t m layout :: *
148− clientWithRoute
63+ clientWithRoute :: Proxy layout -> Proxy m -> Req t -> Dynamic t BaseUrl -> Client t m layout
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
66+instance (HasClient t m a, HasClient t m b) => HasClient t m (a :<|> b) where
67+ type Client t m (a :<|> b) = Client t m a :<|> Client t m b
68+ clientWithRoute Proxy q req baseurl =
69+ clientWithRoute (Proxy :: Proxy a) q req baseurl :<|>
70+ clientWithRoute (Proxy :: Proxy b) q req baseurl
177-- Capture. Example:
72-- Capture. Example:
178-- > type MyApi = "books" :> Capture "isbn" Text :> Get '[JSON] Book
73-- > type MyApi = "books" :> Capture "isbn" Text :> Get '[JSON] Book
180-- > myApi :: Proxy MyApi = Proxy
75-- > myApi :: Proxy MyApi = Proxy
182−-- > getBook :: SupportsServantReflex t m
77+-- > getBook :: MonadWidget t m
183-- => Dynamic t BaseUrl
78-- => Dynamic t BaseUrl
184-- -> Dynamic t (Maybe Text)
79-- -> Dynamic t (Maybe Text)
185−-- -> Event t l
80+-- -> Event t ()
186−-- -> m (Event t (l, ReqResult Book))
81+-- -> m (Event t (Either XhrError (Text, Book)))
187-- > getBook = client myApi (constDyn host)
82-- > getBook = client myApi (constDyn host)
83+instance (MonadWidget t m, KnownSymbol capture, ToHttpApiData a, HasClient t m sublayout)
84+ => 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
86+ type Client t m (Capture capture a :> sublayout) =
87+ Dynamic t (Either Text a) -> Client t m sublayout
192− type Client t m (Capture capture a :> sublayout) tag =
89+ clientWithRoute Proxy q req baseurl val =
193− Dynamic t (Either Text a) -> Client t m sublayout tag
90+ clientWithRoute (Proxy :: Proxy sublayout)
92+ (prependToPathParts p req)
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
95 where p = (fmap . fmap) (toUrlPiece) val
201-- VERB (Returning content) --
97-- VERB (Returning content) --
202instance {-# OVERLAPPABLE #-}
98instance {-# OVERLAPPABLE #-}
203 -- Note [Non-Empty Content Types]
99 -- Note [Non-Empty Content Types]
204− (MimeUnrender ct a, ReflectMethod method, cts' ~ (ct ': cts), SupportsServantReflex t m
100+ (MimeUnrender ct a, ReflectMethod method, cts' ~ (ct ': cts), MonadWidget t m
205− ) => HasClient t m (Verb method status cts' a) tag where
101+ ) => HasClient t m (Verb method status cts' a) where
206− type Client t m (Verb method status cts' a) tag =
102+ type Client t m (Verb method status cts' a) =
207− Event t tag -> m (Event t (ReqResult tag a))
103+ Event t () -> m (Event t (ReqResult a))
208 -- TODO how to access input types here?
104 -- TODO how to access input types here?
209 -- ExceptT ServantError IO a
105 -- ExceptT ServantError IO a
210− clientWithRouteAndResultHandler Proxy _ _ req baseurl opts wrap trigs =
106+ clientWithRoute Proxy _ req baseurl =
211− wrap =<< fmap runIdentity <$> performRequestsCT (Proxy :: Proxy ct) method (constDyn $ Identity $ req') baseurl opts trigs
107+ performRequestCT (Proxy :: Proxy ct) method req' baseurl
212− where method = E.decodeUtf8 $ reflectMethod (Proxy :: Proxy method)
108+ where method = decodeUtf8 $ reflectMethod (Proxy :: Proxy method)
213 req' = req { reqMethod = method }
109 req' = req { reqMethod = method }
216-- -- VERB (No content) --
111-- -- VERB (No content) --
217instance {-# OVERLAPPING #-}
112instance {-# OVERLAPPING #-}
218− (ReflectMethod method, SupportsServantReflex t m) =>
113+ (ReflectMethod method, MonadWidget t m) =>
219− HasClient t m (Verb method status cts NoContent) tag where
114+ HasClient t m (Verb method status cts NoContent) where
220− type Client t m (Verb method status cts NoContent) tag =
115+ type Client t m (Verb method status cts NoContent) =
221− Event t tag -> m (Event t (ReqResult tag NoContent))
116+ Event t () -> m (Event t (ReqResult NoContent))
222 -- TODO: how to access input types here?
117 -- TODO: how to access input types here?
223 -- ExceptT ServantError IO NoContent
118 -- ExceptT ServantError IO NoContent
224− clientWithRouteAndResultHandler Proxy _ _ req baseurl opts wrap trigs =
119+ clientWithRoute Proxy _ req baseurl =
225− wrap =<< fmap runIdentity <$> performRequestsNoBody method (constDyn $ Identity req) baseurl opts trigs
120+ performRequestNoBody method req baseurl
226− where method = E.decodeUtf8 $ reflectMethod (Proxy :: Proxy method)
121+ where method = decodeUtf8 $ reflectMethod (Proxy :: Proxy method)
228−
123+-- -- HEADERS Verb (Content) --
229−toHeaders :: BuildHeadersTo ls => ReqResult tag a -> ReqResult tag (Headers ls a)
124+-- -- Headers combinator not treated in fully general case,
230−toHeaders r =
125+-- -- in order to deny instances for (Headers ls (Capture "id" Int)),
231− let hdrs = maybe []
126+-- -- a combinator that wouldn't make sense
232− (\xhr -> fmap (\(h,v) -> (CI.map E.encodeUtf8 h, E.encodeUtf8 v))
127+-- -- TODO Overlapping??
233− (Map.toList $ _xhrResponse_headers xhr))
128+-- instance {-# OVERLAPPABLE #-}
234− (response r)
129+-- -- Note [Non-Empty Content Types]
130+-- ( MimeUnrender ct a, BuildHeadersTo ls,
131+-- ReflectMethod method, cts' ~ (ct ': cts),
133+-- ) => HasClient t m (Verb method status cts' (Headers ls a)) where
134+-- type Client t m (Verb method status cts' (Headers ls a))
135+-- = Event t () -> m (Event t (Maybe a, XhrResponse))
136+-- -- ExceptT ServantError IO (Headers ls a)
137+-- clientWithRoute Proxy req baseurl = do
138+-- let method = reflectMethod (Proxy :: Proxy method)
139+-- (hdrs, resp) <- performRequestCT (Proxy :: Proxy ct) method req baseurl
140+-- return $ Headers { getResponse = resp
235− in ffor r $ \a -> Headers {getResponse = a ,getHeadersHList = buildHeadersTo hdrs}
141+-- , 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
256-- TODO Overlapping??
144-- 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)))
274−-- HEADERS Verb (No content) --
145+-- -- HEADERS Verb (No content) --
275−instance {-# OVERLAPPABLE #-}
146+-- instance {-# OVERLAPPABLE #-}
276− ( BuildHeadersTo ls, BuildHeaderKeysTo ls, ReflectMethod method,
147+-- ( BuildHeadersTo ls, ReflectMethod method,
277− SupportsServantReflex t m
148+-- MonadWidget t m
278− ) => HasClient t m (Verb method status cts (Headers ls NoContent)) tag where
149+-- ) => HasClient t m (Verb method status cts (Headers ls NoContent)) where
279− type Client t m (Verb method status cts (Headers ls NoContent)) tag
150+-- type Client t m (Verb method status cts (Headers ls NoContent))
151+-- = Event t () -> m (Event t XhrResponse)
280− = Event t tag -> m (Event t (ReqResult tag (Headers ls NoContent)))
152+-- -- ExceptT ServantError IO (Headers ls NoContent)
281− clientWithRouteAndResultHandler Proxy _ _ req baseurl opts wrap trigs = do
153+-- clientWithRoute Proxy req baseurl = do
282− let method = E.decodeUtf8 $ reflectMethod (Proxy :: Proxy method)
154+-- let method = reflectMethod (Proxy :: Proxy method)
283− resp <- fmap runIdentity <$> performRequestsNoBody method (constDyn $ Identity req') baseurl opts trigs
155+-- hdrs <- performRequestNoBody method req baseurl
284− wrap $ toHeaders <$> resp
156+-- return $ Headers { getResponse = NoContent
285− where req' = req {respHeaders =
157+-- , getHeadersHList = buildHeadersTo hdrs
286− OnlyHeaders (Set.fromList (buildHeaderKeysTo (Proxy :: Proxy ls)))
@@ -302,45 +172,32 @@ instance {-# OVERLAPPABLE #-}
302-- > -- then you can just use "viewRefer" to query that endpoint
172-- > -- then you can just use "viewRefer" to query that endpoint
303-- > -- specifying Nothing or e.g Just "http://haskell.org/" as arguments
173-- > -- specifying Nothing or e.g Just "http://haskell.org/" as arguments
304instance (KnownSymbol sym, ToHttpApiData a,
174instance (KnownSymbol sym, ToHttpApiData a,
305− HasClient t m sublayout tag, SupportsServantReflex t m)
175+ HasClient t m sublayout, MonadWidget t m)
306− => HasClient t m (Header sym a :> sublayout) tag where
176+ => HasClient t m (Header sym a :> sublayout) where
308− type Client t m (Header sym a :> sublayout) tag =
178+ type Client t m (Header sym a :> sublayout) =
309− Dynamic t (Either Text a) -> Client t m sublayout tag
179+ Dynamic t (Either Text a) -> Client t m sublayout
311− clientWithRouteAndResultHandler Proxy q t req baseurl opts wrap eVal =
181+ clientWithRoute Proxy q req baseurl _ =
312− clientWithRouteAndResultHandler
313− (Proxy :: Proxy sublayout) q t
182+ clientWithRoute (Proxy :: Proxy sublayout)
185+ -- (maybe req -- TODO Need to pass the header in
314− (Servant.Common.Req.addHeader hname eVal req)
186+ -- (\value -> Servant.Common.Req.addHeader hname value req)
315− baseurl opts wrap
187+ -- mval
316− where hname = T.pack $ symbolVal (Proxy :: Proxy sym)
188+ -- )
321-- | Using a 'HttpVersion' combinator in your API doesn't affect the client
191-- | Using a 'HttpVersion' combinator in your API doesn't affect the client
322-- functions.
192-- functions.
323−instance HasClient t m sublayout tag
193+instance HasClient t m sublayout
324− => HasClient t m (HttpVersion :> sublayout) tag where
194+ => HasClient t m (HttpVersion :> sublayout) 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)
196+ type Client t m (HttpVersion :> sublayout) =
197+ Client t m sublayout
199+ clientWithRoute Proxy q =
200+ clientWithRoute (Proxy :: Proxy sublayout) q
346-- | If you use a 'QueryParam' in one of your endpoints in your API,
203-- | If you use a 'QueryParam' in one of your endpoints in your API,
@@ -369,16 +226,17 @@ instance (HasClient t m sublayout tag, KnownSymbol sym)
369-- > -- then you can just use "getBooksBy" to query that endpoint.
226-- > -- then you can just use "getBooksBy" to query that endpoint.
370-- > -- 'getBooksBy Nothing' for all books
227-- > -- 'getBooksBy Nothing' for all books
371-- > -- 'getBooksBy (Just "Isaac Asimov")' to get all books by Isaac Asimov
228-- > -- 'getBooksBy (Just "Isaac Asimov")' to get all books by Isaac Asimov
372−instance (KnownSymbol sym, ToHttpApiData a, HasClient t m sublayout tag, Reflex t)
229+instance (KnownSymbol sym, ToHttpApiData a, HasClient t m sublayout, Reflex t)
373− => HasClient t m (QueryParam sym a :> sublayout) tag where
230+ => HasClient t m (QueryParam sym a :> sublayout) where
375− type Client t m (QueryParam sym a :> sublayout) tag =
232+ type Client t m (QueryParam sym a :> sublayout) =
233+ -- TODO (Maybe a), or (Maybe (Maybe a))? (should the user be able to send a Nothing)
376− Dynamic t (QParam a) -> Client t m sublayout tag
234+ Dynamic t (QParam a) -> Client t m sublayout
378 -- if mparam = Nothing, we don't add it to the query string
236 -- if mparam = Nothing, we don't add it to the query string
379− clientWithRouteAndResultHandler Proxy q t req baseurl opts wrap mparam =
237+ clientWithRoute Proxy q req baseurl mparam =
380− clientWithRouteAndResultHandler (Proxy :: Proxy sublayout) q t
238+ clientWithRoute (Proxy :: Proxy sublayout) q
381− (req {qParams = paramPair : qParams req}) baseurl opts wrap
239+ (req {qParams = paramPair : qParams req}) baseurl
383 where pname = symbolVal (Proxy :: Proxy sym)
241 where pname = symbolVal (Proxy :: Proxy sym)
384 --p prm = QueryPartParam $ (fmap . fmap) (toQueryParam) prm
242 --p prm = QueryPartParam $ (fmap . fmap) (toQueryParam) prm
@@ -386,8 +244,6 @@ instance (KnownSymbol sym, ToHttpApiData a, HasClient t m sublayout tag, Reflex
386 p prm = QueryPartParam $ fmap qParamToQueryPart prm -- (fmap . fmap) (unpack . toQueryParam) prm
244 p prm = QueryPartParam $ fmap qParamToQueryPart prm -- (fmap . fmap) (unpack . toQueryParam) prm
387 paramPair = (T.pack pname, p mparam)
245 paramPair = (T.pack pname, p mparam)
391-- | If you use a 'QueryParams' in one of your endpoints in your API,
247-- | If you use a 'QueryParams' in one of your endpoints in your API,
392-- the corresponding querying function will automatically take
248-- the corresponding querying function will automatically take
393-- an additional argument, a list of values of the type specified
249-- an additional argument, a list of values of the type specified
@@ -416,22 +272,21 @@ instance (KnownSymbol sym, ToHttpApiData a, HasClient t m sublayout tag, Reflex
416-- > -- 'getBooksBy []' for all books
272-- > -- 'getBooksBy []' for all books
417-- > -- 'getBooksBy ["Isaac Asimov", "Robert A. Heinlein"]'
273-- > -- 'getBooksBy ["Isaac Asimov", "Robert A. Heinlein"]'
418-- > -- to get all books by Asimov and Heinlein
274-- > -- to get all books by Asimov and Heinlein
419−instance (KnownSymbol sym, ToHttpApiData a, HasClient t m sublayout tag, Reflex t)
275+instance (KnownSymbol sym, ToHttpApiData a, HasClient t m sublayout, Reflex t)
420− => HasClient t m (QueryParams sym a :> sublayout) tag where
276+ => HasClient t m (QueryParams sym a :> sublayout) where
422− type Client t m (QueryParams sym a :> sublayout) tag =
278+ type Client t m (QueryParams sym a :> sublayout) =
423− Dynamic t [a] -> Client t m sublayout tag
279+ Dynamic t [a] -> Client t m sublayout
425− clientWithRouteAndResultHandler Proxy q t req baseurl opts wrap paramlist =
281+ clientWithRoute Proxy q req baseurl paramlist =
426− clientWithRouteAndResultHandler (Proxy :: Proxy sublayout) q t req' baseurl opts wrap
282+ clientWithRoute (Proxy :: Proxy sublayout) q req' baseurl
428 where req' = req { qParams = (T.pack pname, params') : qParams req }
284 where req' = req { qParams = (T.pack pname, params') : qParams req }
429 pname = symbolVal (Proxy :: Proxy sym)
285 pname = symbolVal (Proxy :: Proxy sym)
430− params' = QueryPartParams $ (fmap . fmap) toQueryParam
286+ params' = QueryPartParams $ (fmap . fmap) (toQueryParam)
431 paramlist
287 paramlist
435-- | If you use a 'QueryFlag' in one of your endpoints in your API,
290-- | If you use a 'QueryFlag' in one of your endpoints in your API,
436-- the corresponding querying function will automatically take
291-- the corresponding querying function will automatically take
437-- an additional 'Bool' argument.
292-- an additional 'Bool' argument.
@@ -456,42 +311,49 @@ instance (KnownSymbol sym, ToHttpApiData a, HasClient t m sublayout tag, Reflex
456-- > -- 'getBooksBy True' to only get _already published_ books
311-- > -- 'getBooksBy True' to only get _already published_ books
458-- TODO Bring back
313-- TODO Bring back
459−instance (KnownSymbol sym, HasClient t m sublayout tag, Reflex t)
314+instance (KnownSymbol sym, HasClient t m sublayout, Reflex t)
460− => HasClient t m (QueryFlag sym :> sublayout) tag where
315+ => HasClient t m (QueryFlag sym :> sublayout) where
462− type Client t m (QueryFlag sym :> sublayout) tag =
317+ type Client t m (QueryFlag sym :> sublayout) =
463− Dynamic t Bool -> Client t m sublayout tag
318+ Dynamic t Bool -> Client t m sublayout
465− clientWithRouteAndResultHandler Proxy q t req baseurl opts wrap flag =
320+ clientWithRoute Proxy q req baseurl flag =
466− clientWithRouteAndResultHandler (Proxy :: Proxy sublayout) q t req' baseurl opts wrap
321+ clientWithRoute (Proxy :: Proxy sublayout) q req' baseurl
468 where req' = req { qParams = thisPair : qParams req }
323 where req' = req { qParams = thisPair : qParams req }
469 thisPair = (T.pack pName, QueryPartFlag flag) :: (Text, QueryPart t)
324 thisPair = (T.pack pName, QueryPartFlag flag) :: (Text, QueryPart t)
470 pName = symbolVal (Proxy :: Proxy sym)
325 pName = symbolVal (Proxy :: Proxy sym)
473−
328+-- | Pick a 'Method' and specify where the server you want to query is. You get
474−-- | Send a raw 'XhrRequest ()' directly to 'baseurl'
329+-- back the full `Response`.
475−instance SupportsServantReflex t m => HasClient t m Raw tag where
331+instance (MonadWidget t m) => HasClient t m Raw where
476− type Client t m Raw tag = Dynamic t (Either Text (XhrRequest ()))
332+ type Client t m Raw = Dynamic t (Either Text (XhrRequest ()))
477− -> Event t tag
333+ -> Event t ()
478− -> m (Event t (ReqResult tag ()))
334+ -> m (Event t (ReqResult ()))
480− clientWithRouteAndResultHandler _ _ _ _ baseurl _ wrap xhrs triggers = do
336+ -- clientWithRoute :: Proxy Raw -> Proxy m -> Req -> BaseUrl -> Client t m Raw
481−
337+ clientWithRoute _ _ _ baseurl xhrs triggers = do
482− let xhrs' = liftA2 (\x path -> case x of
338+ let xhrs' = liftA2 (\x path -> case x of
483− Left e -> Left e
339+ Left e -> Left e
484− Right jx -> Right $ jx { _xhrRequest_url = path <> _xhrRequest_url jx }
340+ Right jx -> Right $ jx {_xhrRequest_url = path
341+ <> _xhrRequest_url jx})
485− ) xhrs (showBaseUrl <$> baseurl)
343+ (showBaseUrl <$> baseurl)
486− xhrs'' = attachPromptlyDynWith (flip (,)) xhrs' triggers :: Event t (tag, Either Text (XhrRequest ()))
344+ reqs = tagDyn xhrs' triggers
487− badReq = fmapMaybe (\(t,x) -> either (Just . (t,)) (const Nothing) x) xhrs'' :: Event t (tag, Text)
345+ okReq = fmapMaybe hush reqs
488− okReq = fmapMaybe (\(t,x) -> either (const Nothing) (Just . (t,)) x) xhrs'' :: Event t (tag, XhrRequest ())
346+ badReq = fmapMaybe tattle reqs
489−
347+ resps <- performRequestAsync okReq
490− resps <- performRequestsAsync okReq
348+ return $ leftmost [fmap (ResponseSuccess () ) resps
491− wrap $ leftmost [ uncurry RequestFailure <$> badReq
349+ ,fmap RequestFailure badReq]
492− , evalResponse (const $ Right ()) <$> resps
350+
494−
352+hush :: Either e a -> Maybe a
353+hush = either (const Nothing) Just
355+tattle :: Either e a -> Maybe e
356+tattle = either Just (const Nothing)
496-- | If you use a 'ReqBody' in one of your endpoints in your API,
358-- | If you use a 'ReqBody' in one of your endpoints in your API,
497-- the corresponding querying function will automatically take
359-- the corresponding querying function will automatically take
@@ -513,64 +375,59 @@ instance SupportsServantReflex t m => HasClient t m Raw tag where
513-- > where host = BaseUrl Http "localhost" 8080
375-- > where host = BaseUrl Http "localhost" 8080
514-- > -- then you can just use "addBook" to query that endpoint
376-- > -- then you can just use "addBook" to query that endpoint
516−instance (MimeRender ct a, HasClient t m sublayout tag, Reflex t)
378+instance (MimeRender ct a, HasClient t m sublayout, Reflex t)
517− => HasClient t m (ReqBody (ct ': cts) a :> sublayout) tag where
379+ => HasClient t m (ReqBody (ct ': cts) a :> sublayout) where
519− type Client t m (ReqBody (ct ': cts) a :> sublayout) tag =
381+ type Client t m (ReqBody (ct ': cts) a :> sublayout) =
520− Dynamic t (Either Text a) -> Client t m sublayout tag
382+ Dynamic t (Either Text a) -> Client t m sublayout
522− clientWithRouteAndResultHandler Proxy q t req baseurl opts wrap body =
384+ clientWithRoute Proxy q req baseurl body =
523− clientWithRouteAndResultHandler (Proxy :: Proxy sublayout) q t req' baseurl opts wrap
385+ clientWithRoute (Proxy :: Proxy sublayout) q req' baseurl
524 where req' = req { reqBody = bodyBytesCT }
386 where req' = req { reqBody = bodyBytesCT }
525 ctProxy = Proxy :: Proxy ct
387 ctProxy = Proxy :: Proxy ct
526 ctString = T.pack $ show $ contentType ctProxy
388 ctString = T.pack $ show $ contentType ctProxy
389+ --ctString = decodeUtf8 . CI.original . M.mainType $ contentType ctProxy
527 bodyBytesCT = Just $ (fmap . fmap)
390 bodyBytesCT = Just $ (fmap . fmap)
528 (\b -> (mimeRender ctProxy b, ctString))
391 (\b -> (mimeRender ctProxy b, ctString))
533-- | Make the querying function append @path@ to the request path.
394-- | 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
395+instance (KnownSymbol path, HasClient t m sublayout, Reflex t) => HasClient t m (path :> sublayout) where
535− type Client t m (path :> sublayout) tag = Client t m sublayout tag
396+ type Client t m (path :> sublayout) = Client t m sublayout
537− clientWithRouteAndResultHandler Proxy q t req baseurl opts wrap =
398+ clientWithRoute Proxy q req baseurl =
538− clientWithRouteAndResultHandler (Proxy :: Proxy sublayout) q t
399+ clientWithRoute (Proxy :: Proxy sublayout) q
539− (prependToPathParts (pure (Right $ T.pack p)) req) baseurl opts wrap
400+ (prependToPathParts (pure (Right $ T.pack p)) req)
541 where p = symbolVal (Proxy :: Proxy path)
403 where p = symbolVal (Proxy :: Proxy path)
405+instance HasClient t m api => HasClient t m (Vault :> api) where
406+ type Client t m (Vault :> api) = Client t m api
544−instance HasClient t m api tag => HasClient t m (Vault :> api) tag where
408+ clientWithRoute Proxy q req baseurl =
545− type Client t m (Vault :> api) tag = Client t m api tag
409+ clientWithRoute (Proxy :: Proxy api) q req baseurl
547− clientWithRouteAndResultHandler Proxy =
548− clientWithRouteAndResultHandler (Proxy :: Proxy api)
551−instance HasClient t m api tag => HasClient t m (RemoteHost :> api) tag where
411+instance HasClient t m api => HasClient t m (RemoteHost :> api) where
552− type Client t m (RemoteHost :> api) tag = Client t m api tag
412+ type Client t m (RemoteHost :> api) = Client t m api
554− clientWithRouteAndResultHandler Proxy =
414+ clientWithRoute Proxy q req baseurl =
555− clientWithRouteAndResultHandler (Proxy :: Proxy api)
415+ clientWithRoute (Proxy :: Proxy api) q req baseurl
417+instance HasClient t m api => HasClient t m (IsSecure :> api) where
418+ type Client t m (IsSecure :> api) = Client t m api
420+ clientWithRoute Proxy q req baseurl =
421+ clientWithRoute (Proxy :: Proxy api) q req baseurl
559−instance HasClient t m api tag => HasClient t m (IsSecure :> api) tag where
423+instance (HasClient t m api, Reflex t)
560− type Client t m (IsSecure :> api) tag = Client t m api tag
424+ => HasClient t m (BasicAuth realm usr :> api) where
562− clientWithRouteAndResultHandler Proxy =
426+ type Client t m (BasicAuth realm usr :> api) = Dynamic t (Maybe BasicAuthData)
563− clientWithRouteAndResultHandler (Proxy :: Proxy api)
427+ -> Client t m api
566−instance (HasClient t m api tag, Reflex t)
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 =
429+ clientWithRoute Proxy q req baseurl authdata =
573− clientWithRouteAndResultHandler (Proxy :: Proxy api) q t req' baseurl opts wrap
430+ clientWithRoute (Proxy :: Proxy api) q req' baseurl
575 req' = req { authData = Just authdata }
432 req' = req { authData = Just authdata }
@@ -596,30 +453,3 @@ non-empty lists, but is otherwise more specific, no instance will be overall
596more specific. This in turn generally means adding yet another instance (one
453more specific. This in turn generally means adding yet another instance (one
597for empty and one for non-empty lists).
454for 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