@@ -1,23 +1,16 @@
1−{-# LANGUAGE AllowAmbiguousTypes #-}
2−{-# LANGUAGE CPP #-}
3−{-# LANGUAGE DataKinds #-}
4−{-# LANGUAGE FlexibleContexts #-}
5−{-# LANGUAGE FlexibleInstances #-}
6−{-# LANGUAGE GeneralizedNewtypeDeriving #-}
7−{-# LANGUAGE InstanceSigs #-}
8−{-# LANGUAGE MultiParamTypeClasses #-}
9−{-# LANGUAGE OverloadedStrings #-}
10−{-# LANGUAGE PolyKinds #-}
11−{-# LANGUAGE Rank2Types #-}
12−{-# LANGUAGE ScopedTypeVariables #-}
13−{-# LANGUAGE TupleSections #-}
14−{-# LANGUAGE TypeFamilies #-}
15−{-# LANGUAGE TypeOperators #-}
16−{-# LANGUAGE UndecidableInstances #-}
17−
18−#if MIN_VERSION_base(4,9,0)
19−{-# OPTIONS_GHC -fno-warn-redundant-constraints #-}
20−#endif
1+{-# LANGUAGE CPP #-}
2+{-# LANGUAGE DataKinds #-}
3+{-# LANGUAGE FlexibleContexts #-}
4+{-# LANGUAGE FlexibleInstances #-}
5+{-# LANGUAGE InstanceSigs #-}
6+{-# LANGUAGE OverloadedStrings #-}
7+{-# LANGUAGE PolyKinds #-}
8+{-# LANGUAGE ScopedTypeVariables #-}
9+{-# LANGUAGE TupleSections #-}
10+{-# LANGUAGE TypeFamilies #-}
11+{-# LANGUAGE TypeOperators #-}
12+{-# LANGUAGE UndecidableInstances #-}
13+{-# LANGUAGE MultiParamTypeClasses #-}
2114
2215-- #include "overlapping-compat.h"
2316-- | This module provides 'client' which can automatically generate
@@ -25,71 +18,31 @@
2518-- API.
2619module Servant.Reflex
2720 ( client
28− , clientWithOpts
29− , clientWithOptsAndResultHandler
30− , clientWithRoute
31− , clientWithRouteAndResultHandler
32− , BuildHeaderKeysTo(..)
33− , toHeaders
34− , HasClient
35− , Client
21+ , HasClient(..)
3622 , module Servant.Common.Req
3723 , module Servant.Common.BaseUrl
3824 ) where
3925
40−------------------------------------------------------------------------------
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−
26+import Control.Applicative ((<$>), liftA2)
27+import Control.Monad.Trans.Except
28+import qualified Data.ByteString.Char8 as BS
29+import Data.ByteString.Lazy (ByteString)
30+import qualified Data.CaseInsensitive as CI
31+import Data.List
32+import Data.Proxy
33+import Data.String.Conversions
34+import Data.Maybe (maybeToList)
35+import Data.Text (unpack)
36+import Data.Traversable (sequenceA)
37+import GHC.TypeLits
38+import qualified Network.HTTP.Media as M
39+import Servant.API
40+import Servant.Common.BaseUrl
41+import Servant.Common.Req
42+import Servant.API.ContentTypes
43+import Reflex
44+import Reflex.Dom
45+import Reflex.Dom.Xhr
9346
9447-- * Accessing APIs as a Client
9548
@@ -101,191 +54,116 @@ import Servant.Common.Req (ClientOptions(..),
10154-- > myApi :: Proxy MyApi
10255-- > myApi = Proxy
10356-- >
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)))
57+-- > getAllBooks :: Event t () -> m (Event t (Either XhrError ((),[Book])))
58+-- > postNewBook :: Behavior t (Maybe Book) -> Event t ()
59+-- -> m (Event t (Either XhrError (Book,Book)))
10760-- > (getAllBooks :<|> postNewBook) = client myApi host
10861-- > where host = constDyn $ BaseUrl Http "localhost" 8080
109−client
110− :: (HasClient t m layout tag)
111− => Proxy layout
112− -> Proxy m
113− -> Proxy tag
114− -> Dynamic t BaseUrl
115− -> Client t m layout tag
116−client p q t baseurl = clientWithRoute p q t defReq baseurl defaultClientOptions
117−
118−clientWithOpts
119− :: (HasClient t m layout tag)
120− => Proxy layout
121− -> Proxy m
122− -> Proxy tag
123− -> Dynamic t BaseUrl
124− -> ClientOptions
125− -> Client t m layout tag
126−clientWithOpts p q t baseurl = clientWithRoute p q t defReq baseurl
127−
128−-- | Like 'clientWithOpts' but allows passing a function which will process the
129−-- result event in some way. This can be used to handle errors in a uniform way
130−-- across call sites.
131−clientWithOptsAndResultHandler
132− :: (HasClient t m layout tag)
133− => Proxy layout
134− -> Proxy m
135− -> Proxy tag
136− -> Dynamic t BaseUrl
137− -> ClientOptions
138− -> (forall a. Event t (ReqResult tag a) -> m (Event t (ReqResult tag a)))
139− -> Client t m layout tag
140−clientWithOptsAndResultHandler p q t = clientWithRouteAndResultHandler p q t defReq
141−
62+client :: (HasClient t m layout, MonadWidget t m)
63+ => Proxy layout -> Proxy m -> Dynamic t BaseUrl -> Client t m layout
64+client p q baseurl = clientWithRoute p q defReq baseurl
14265
14366-- | This class lets us define how each API combinator
14467-- influences the creation of an HTTP request. It's mostly
14568-- an internal class, you can just use 'client'.
146−class Monad m => HasClient t m layout (tag :: *) where
147− type Client t m layout tag :: *
148− clientWithRoute
149− :: Proxy layout
150− -> Proxy m
151− -> Proxy tag
152− -> Req t
153− -> Dynamic t BaseUrl
154− -> ClientOptions
155− -> Client t m layout tag
156− clientWithRoute l m t r b o = clientWithRouteAndResultHandler l m t r b o return
157−
158− clientWithRouteAndResultHandler
159− :: Proxy layout
160− -> Proxy m
161− -> Proxy tag
162− -> Req t
163− -> Dynamic t BaseUrl
164− -> ClientOptions
165− -> (forall a. Event t (ReqResult tag a) -> m (Event t (ReqResult tag a)))
166− -> Client t m layout tag
167−
168−
169−instance (HasClient t m a tag, HasClient t m b tag) => HasClient t m (a :<|> b) tag where
170− type Client t m (a :<|> b) tag = Client t m a tag :<|> Client t m b tag
171−
172− clientWithRouteAndResultHandler Proxy q pTag req baseurl opts wrap =
173− clientWithRouteAndResultHandler (Proxy :: Proxy a) q pTag req baseurl opts wrap :<|>
174− clientWithRouteAndResultHandler (Proxy :: Proxy b) q pTag req baseurl opts wrap
69+class HasClient t m layout where
70+ type Client t m layout :: *
71+ clientWithRoute :: Proxy layout -> Proxy m -> Req t -> Dynamic t BaseUrl -> Client t m layout
17572
17673
74+instance (HasClient t m a, HasClient t m b) => HasClient t m (a :<|> b) where
75+ type Client t m (a :<|> b) = Client t m a :<|> Client t m b
76+ clientWithRoute Proxy q req baseurl =
77+ clientWithRoute (Proxy :: Proxy a) q req baseurl :<|>
78+ clientWithRoute (Proxy :: Proxy b) q req baseurl
79+
17780-- Capture. Example:
17881-- > type MyApi = "books" :> Capture "isbn" Text :> Get '[JSON] Book
17982-- >
18083-- > myApi :: Proxy MyApi = Proxy
18184-- >
182−-- > getBook :: SupportsServantReflex t m
85+-- > getBook :: MonadWidget t m
18386-- => Dynamic t BaseUrl
184−-- -> Dynamic t (Maybe Text)
185−-- -> Event t l
186−-- -> m (Event t (l, ReqResult Book))
87+-- -> Behavior t (Maybe Text)
88+-- -> Event t ()
89+-- -> m (Event t (Either XhrError (Text, Book)))
18790-- > getBook = client myApi (constDyn host)
91+instance (MonadWidget t m, KnownSymbol capture, ToHttpApiData a, HasClient t m sublayout)
92+ => HasClient t m (Capture capture a :> sublayout) where
18893
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
94+ type Client t m (Capture capture a :> sublayout) =
95+ Behavior t (Either String a) -> Client t m sublayout
19496
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
97+ clientWithRoute Proxy q req baseurl val =
98+ clientWithRoute (Proxy :: Proxy sublayout)
99+ q
100+ (prependToPathParts p req)
101+ baseurl
199102
103+ where p = (fmap . fmap) (unpack . toUrlPiece) val
200104
201105-- VERB (Returning content) --
202106instance {-# OVERLAPPABLE #-}
203107 -- Note [Non-Empty Content Types]
204− (MimeUnrender ct a, ReflectMethod method, cts' ~ (ct ': cts), SupportsServantReflex t m
205− ) => HasClient t m (Verb method status cts' a) tag where
206− type Client t m (Verb method status cts' a) tag =
207− Event t tag -> m (Event t (ReqResult tag a))
108+ (MimeUnrender ct a, ReflectMethod method, cts' ~ (ct ': cts), MonadWidget t m
109+ ) => HasClient t m (Verb method status cts' a) where
110+ type Client t m (Verb method status cts' a) =
111+ Event t () -> m (Event t (ReqResult a))
208112 -- TODO how to access input types here?
209113 -- ExceptT ServantError IO a
210− clientWithRouteAndResultHandler Proxy _ _ req baseurl opts wrap trigs =
211− wrap =<< fmap runIdentity <$> performRequestsCT (Proxy :: Proxy ct) method (constDyn $ Identity $ req') baseurl opts trigs
212− where method = E.decodeUtf8 $ reflectMethod (Proxy :: Proxy method)
114+ clientWithRoute Proxy q req baseurl =
115+ performRequestCT (Proxy :: Proxy ct) method req' baseurl
116+ where method = BS.unpack $ reflectMethod (Proxy :: Proxy method)
213117 req' = req { reqMethod = method }
214118
215−
216119-- -- VERB (No content) --
217120instance {-# 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))
121+ (ReflectMethod method, MonadWidget t m) =>
122+ HasClient t m (Verb method status cts NoContent) where
123+ type Client t m (Verb method status cts NoContent) =
124+ Event t () -> m (Event t (ReqResult NoContent))
222125 -- TODO: how to access input types here?
223126 -- ExceptT ServantError IO NoContent
224− clientWithRouteAndResultHandler Proxy _ _ req baseurl opts wrap trigs =
225− wrap =<< fmap runIdentity <$> performRequestsNoBody method (constDyn $ Identity req) baseurl opts trigs
226− where method = E.decodeUtf8 $ reflectMethod (Proxy :: Proxy method)
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}
127+ clientWithRoute Proxy q req baseurl =
128+ performRequestNoBody method req baseurl
129+ where method = BS.unpack $ reflectMethod (Proxy :: Proxy method)
130+
131+-- -- HEADERS Verb (Content) --
132+-- -- Headers combinator not treated in fully general case,
133+-- -- in order to deny instances for (Headers ls (Capture "id" Int)),
134+-- -- a combinator that wouldn't make sense
135+-- -- TODO Overlapping??
136+-- instance {-# OVERLAPPABLE #-}
137+-- -- Note [Non-Empty Content Types]
138+-- ( MimeUnrender ct a, BuildHeadersTo ls,
139+-- ReflectMethod method, cts' ~ (ct ': cts),
140+-- MonadWidget t m
141+-- ) => HasClient t m (Verb method status cts' (Headers ls a)) where
142+-- type Client t m (Verb method status cts' (Headers ls a))
143+-- = Event t () -> m (Event t (Maybe a, XhrResponse))
144+-- -- ExceptT ServantError IO (Headers ls a)
145+-- clientWithRoute Proxy req baseurl = do
146+-- let method = reflectMethod (Proxy :: Proxy method)
147+-- (hdrs, resp) <- performRequestCT (Proxy :: Proxy ct) method req baseurl
148+-- return $ Headers { getResponse = resp
149+-- , getHeadersHList = buildHeadersTo hdrs
150+-- }
236151
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−
251−
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
256152-- 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)))
271− }
272−
273−
274−-- HEADERS Verb (No content) --
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)))
287− }
288−
153+-- -- HEADERS Verb (No content) --
154+-- instance {-# OVERLAPPABLE #-}
155+-- ( BuildHeadersTo ls, ReflectMethod method,
156+-- MonadWidget t m
157+-- ) => HasClient t m (Verb method status cts (Headers ls NoContent)) where
158+-- type Client t m (Verb method status cts (Headers ls NoContent))
159+-- = Event t () -> m (Event t XhrResponse)
160+-- -- ExceptT ServantError IO (Headers ls NoContent)
161+-- clientWithRoute Proxy req baseurl = do
162+-- let method = reflectMethod (Proxy :: Proxy method)
163+-- hdrs <- performRequestNoBody method req baseurl
164+-- return $ Headers { getResponse = NoContent
165+-- , getHeadersHList = buildHeadersTo hdrs
166+-- }
289167
290168
291169-- HEADER
@@ -302,46 +180,34 @@ instance {-# OVERLAPPABLE #-}
302180-- > -- then you can just use "viewRefer" to query that endpoint
303181-- > -- specifying Nothing or e.g Just "http://haskell.org/" as arguments
304182instance (KnownSymbol sym, ToHttpApiData a,
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)
183+ HasClient t m sublayout, MonadWidget t m)
184+ => HasClient t m (Header sym a :> sublayout) where
317185
186+ type Client t m (Header sym a :> sublayout) =
187+ Behavior t (Either String a) -> Client t m sublayout
318188
189+ clientWithRoute Proxy q req baseurl eval =
190+ clientWithRoute (Proxy :: Proxy sublayout)
191+ q
192+ (Servant.Common.Req.addHeader hname eval req)
193+ -- (maybe req -- TODO Need to pass the header in
194+ -- (\value -> Servant.Common.Req.addHeader hname value req)
195+ -- mval
196+ -- )
197+ baseurl
319198
199+ where hname = symbolVal (Proxy :: Proxy sym)
320200
321201-- | Using a 'HttpVersion' combinator in your API doesn't affect the client
322202-- functions.
323−instance HasClient t m sublayout tag
324− => HasClient t m (HttpVersion :> sublayout) tag where
325−
326− type Client t m (HttpVersion :> sublayout) tag =
327− Client t m sublayout tag
328−
329− clientWithRouteAndResultHandler Proxy =
330− clientWithRouteAndResultHandler (Proxy :: Proxy sublayout)
331−
332−-- | Using a 'Summary' combinator in your API doesn't affect the client
333−-- functions.
334−instance (HasClient t m sublayout tag, KnownSymbol sym)
335− => HasClient t m (Summary sym :> sublayout) tag where
336−
337− type Client t m (Summary sym :> sublayout) tag =
338− Client t m sublayout tag
339−
340− clientWithRouteAndResultHandler Proxy =
341− clientWithRouteAndResultHandler (Proxy :: Proxy sublayout)
342−
203+instance HasClient t m sublayout
204+ => HasClient t m (HttpVersion :> sublayout) where
343205
206+ type Client t m (HttpVersion :> sublayout) =
207+ Client t m sublayout
344208
209+ clientWithRoute Proxy q =
210+ clientWithRoute (Proxy :: Proxy sublayout) q
345211
346212-- | If you use a 'QueryParam' in one of your endpoints in your API,
347213-- the corresponding querying function will automatically take
@@ -369,24 +235,21 @@ instance (HasClient t m sublayout tag, KnownSymbol sym)
369235-- > -- then you can just use "getBooksBy" to query that endpoint.
370236-- > -- 'getBooksBy Nothing' for all books
371237-- > -- 'getBooksBy (Just "Isaac Asimov")' to get all books by Isaac Asimov
372−instance (KnownSymbol sym, ToHttpApiData a, HasClient t m sublayout tag, Reflex t)
373− => HasClient t m (QueryParam sym a :> sublayout) tag where
238+instance (KnownSymbol sym, ToHttpApiData a, HasClient t m sublayout, Reflex t)
239+ => HasClient t m (QueryParam sym a :> sublayout) where
374240
375− type Client t m (QueryParam sym a :> sublayout) tag =
376− Dynamic t (QParam a) -> Client t m sublayout tag
241+ type Client t m (QueryParam sym a :> sublayout) =
242+ -- TODO (Maybe a), or (Maybe (Maybe a))? (should the user be able to send a Nothing)
243+ Behavior t (Either String a) -> Client t m sublayout
377244
378245 -- if mparam = Nothing, we don't add it to the query string
379− clientWithRouteAndResultHandler Proxy q t req baseurl opts wrap mparam =
380− clientWithRouteAndResultHandler (Proxy :: Proxy sublayout) q t
381− (req {qParams = paramPair : qParams req}) baseurl opts wrap
246+ clientWithRoute Proxy q req baseurl mparam =
247+ clientWithRoute (Proxy :: Proxy sublayout) q
248+ (req {qParams = paramPair : qParams req}) baseurl
382249
383250 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−
251+ p prm = QueryPartParam $ (fmap . fmap) (unpack . toQueryParam) prm
252+ paramPair = (pname, p mparam)
390253
391254-- | If you use a 'QueryParams' in one of your endpoints in your API,
392255-- the corresponding querying function will automatically take
@@ -416,22 +279,21 @@ instance (KnownSymbol sym, ToHttpApiData a, HasClient t m sublayout tag, Reflex
416279-- > -- 'getBooksBy []' for all books
417280-- > -- 'getBooksBy ["Isaac Asimov", "Robert A. Heinlein"]'
418281-- > -- to get all books by Asimov and Heinlein
419−instance (KnownSymbol sym, ToHttpApiData a, HasClient t m sublayout tag, Reflex t)
420− => HasClient t m (QueryParams sym a :> sublayout) tag where
282+instance (KnownSymbol sym, ToHttpApiData a, HasClient t m sublayout, Reflex t)
283+ => HasClient t m (QueryParams sym a :> sublayout) where
421284
422− type Client t m (QueryParams sym a :> sublayout) tag =
423− Dynamic t [a] -> Client t m sublayout tag
285+ type Client t m (QueryParams sym a :> sublayout) =
286+ Behavior t [a] -> Client t m sublayout
424287
425− clientWithRouteAndResultHandler Proxy q t req baseurl opts wrap paramlist =
426− clientWithRouteAndResultHandler (Proxy :: Proxy sublayout) q t req' baseurl opts wrap
288+ clientWithRoute Proxy q req baseurl paramlist =
289+ clientWithRoute (Proxy :: Proxy sublayout) q req' baseurl
427290
428− where req' = req { qParams = (T.pack pname, params') : qParams req }
291+ where req' = req { qParams = (pname, params') : qParams req }
429292 pname = symbolVal (Proxy :: Proxy sym)
430− params' = QueryPartParams $ (fmap . fmap) toQueryParam
293+ params' = QueryPartParams $ (fmap . fmap) (unpack . toQueryParam)
431294 paramlist
432295
433296
434−
435297-- | If you use a 'QueryFlag' in one of your endpoints in your API,
436298-- the corresponding querying function will automatically take
437299-- an additional 'Bool' argument.
@@ -456,42 +318,49 @@ instance (KnownSymbol sym, ToHttpApiData a, HasClient t m sublayout tag, Reflex
456318-- > -- 'getBooksBy True' to only get _already published_ books
457319
458320-- TODO Bring back
459−instance (KnownSymbol sym, HasClient t m sublayout tag, Reflex t)
460− => HasClient t m (QueryFlag sym :> sublayout) tag where
321+instance (KnownSymbol sym, HasClient t m sublayout, Reflex t)
322+ => HasClient t m (QueryFlag sym :> sublayout) where
461323
462− type Client t m (QueryFlag sym :> sublayout) tag =
463− Dynamic t Bool -> Client t m sublayout tag
324+ type Client t m (QueryFlag sym :> sublayout) =
325+ Behavior t Bool -> Client t m sublayout
464326
465− clientWithRouteAndResultHandler Proxy q t req baseurl opts wrap flag =
466− clientWithRouteAndResultHandler (Proxy :: Proxy sublayout) q t req' baseurl opts wrap
327+ clientWithRoute Proxy q req baseurl flag =
328+ clientWithRoute (Proxy :: Proxy sublayout) q req' baseurl
467329
468330 where req' = req { qParams = thisPair : qParams req }
469− thisPair = (T.pack pName, QueryPartFlag flag) :: (Text, QueryPart t)
331+ thisPair = (pName, QueryPartFlag flag) :: (String, QueryPart t)
470332 pName = symbolVal (Proxy :: Proxy sym)
471333
472334
473−
474−-- | Send a raw 'XhrRequest ()' directly to 'baseurl'
475−instance SupportsServantReflex t m => HasClient t m Raw tag where
476− type Client t m Raw tag = Dynamic t (Either Text (XhrRequest ()))
477− -> Event t tag
478− -> m (Event t (ReqResult tag ()))
479−
480− clientWithRouteAndResultHandler _ _ _ _ baseurl _ wrap xhrs triggers = do
481−
482− let xhrs' = liftA2 (\x path -> case x of
483− Left e -> Left e
484− Right jx -> Right $ jx { _xhrRequest_url = path <> _xhrRequest_url jx }
485− ) xhrs (showBaseUrl <$> baseurl)
486− xhrs'' = attachPromptlyDynWith (flip (,)) xhrs' triggers :: Event t (tag, Either Text (XhrRequest ()))
487− badReq = fmapMaybe (\(t,x) -> either (Just . (t,)) (const Nothing) x) xhrs'' :: Event t (tag, Text)
488− okReq = fmapMaybe (\(t,x) -> either (const Nothing) (Just . (t,)) x) xhrs'' :: Event t (tag, XhrRequest ())
489−
490− resps <- performRequestsAsync okReq
491− wrap $ leftmost [ uncurry RequestFailure <$> badReq
492− , evalResponse (const $ Right ()) <$> resps
493− ]
494−
335+-- | Pick a 'Method' and specify where the server you want to query is. You get
336+-- back the full `Response`.
337+-- TODO redo
338+instance (MonadWidget t m) => HasClient t m Raw where
339+ type Client t m Raw = Behavior t (Either String XhrRequest)
340+ -> Event t ()
341+ -> m (Event t (ReqResult ()))
342+
343+ -- clientWithRoute :: Proxy Raw -> Proxy m -> Req -> BaseUrl -> Client t m Raw
344+ clientWithRoute p q req baseurl xhrs triggers = do
345+ let xhrs' = liftA2 (\x path -> case x of
346+ Left e -> Left e
347+ Right jx -> Right $ jx {_xhrRequest_url = path
348+ ++ _xhrRequest_url jx})
349+ xhrs
350+ (showBaseUrl <$> current baseurl)
351+ reqs = tag xhrs' triggers
352+ okReq = fmapMaybe hush reqs
353+ badReq = fmapMaybe tattle reqs
354+ resps <- performRequestAsync okReq
355+ return $ leftmost [fmap (ResponseSuccess () ) resps
356+ ,fmap RequestFailure badReq]
357+
358+
359+hush :: Either e a -> Maybe a
360+hush = either (const Nothing) Just
361+
362+tattle :: Either e a -> Maybe e
363+tattle = either Just (const Nothing)
495364
496365-- | If you use a 'ReqBody' in one of your endpoints in your API,
497366-- the corresponding querying function will automatically take
@@ -513,64 +382,59 @@ instance SupportsServantReflex t m => HasClient t m Raw tag where
513382-- > where host = BaseUrl Http "localhost" 8080
514383-- > -- then you can just use "addBook" to query that endpoint
515384
516−instance (MimeRender ct a, HasClient t m sublayout tag, Reflex t)
517− => HasClient t m (ReqBody (ct ': cts) a :> sublayout) tag where
385+instance (MimeRender ct a, HasClient t m sublayout, Reflex t)
386+ => HasClient t m (ReqBody (ct ': cts) a :> sublayout) where
518387
519− type Client t m (ReqBody (ct ': cts) a :> sublayout) tag =
520− Dynamic t (Either Text a) -> Client t m sublayout tag
388+ type Client t m (ReqBody (ct ': cts) a :> sublayout) =
389+ Behavior t (Either String a) -> Client t m sublayout
521390
522− clientWithRouteAndResultHandler Proxy q t req baseurl opts wrap body =
523− clientWithRouteAndResultHandler (Proxy :: Proxy sublayout) q t req' baseurl opts wrap
391+ clientWithRoute Proxy q req baseurl body =
392+ clientWithRoute (Proxy :: Proxy sublayout) q req' baseurl
524393 where req' = req { reqBody = bodyBytesCT }
525394 ctProxy = Proxy :: Proxy ct
526− ctString = T.pack $ show $ contentType ctProxy
395+ ctString = show $ contentType ctProxy
396+ --ctString = BS.unpack . CI.original . M.mainType $ contentType ctProxy
527397 bodyBytesCT = Just $ (fmap . fmap)
528398 (\b -> (mimeRender ctProxy b, ctString))
529399 body
530400
531−
532−
533401-- | Make the querying function append @path@ to the request path.
534−instance (KnownSymbol path, HasClient t m sublayout tag, Reflex t) => HasClient t m (path :> sublayout) tag where
535− type Client t m (path :> sublayout) tag = Client t m sublayout tag
402+instance (KnownSymbol path, HasClient t m sublayout, Reflex t) => HasClient t m (path :> sublayout) where
403+ type Client t m (path :> sublayout) = Client t m sublayout
536404
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
405+ clientWithRoute Proxy q req baseurl =
406+ clientWithRoute (Proxy :: Proxy sublayout) q
407+ (prependToPathParts (constant (Right p)) req)
408+ baseurl
540409
541410 where p = symbolVal (Proxy :: Proxy path)
542411
412+instance HasClient t m api => HasClient t m (Vault :> api) where
413+ type Client t m (Vault :> api) = Client t m api
543414
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
415+ clientWithRoute Proxy q req baseurl =
416+ clientWithRoute (Proxy :: Proxy api) q req baseurl
553417
554− clientWithRouteAndResultHandler Proxy =
555− clientWithRouteAndResultHandler (Proxy :: Proxy api)
418+instance HasClient t m api => HasClient t m (RemoteHost :> api) where
419+ type Client t m (RemoteHost :> api) = Client t m api
556420
421+ clientWithRoute Proxy q req baseurl =
422+ clientWithRoute (Proxy :: Proxy api) q req baseurl
557423
424+instance HasClient t m api => HasClient t m (IsSecure :> api) where
425+ type Client t m (IsSecure :> api) = Client t m api
558426
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
427+ clientWithRoute Proxy q req baseurl =
428+ clientWithRoute (Proxy :: Proxy api) q req baseurl
561429
562− clientWithRouteAndResultHandler Proxy =
563− clientWithRouteAndResultHandler (Proxy :: Proxy api)
430+instance (HasClient t m api, Reflex t)
431+ => HasClient t m (BasicAuth realm usr :> api) where
564432
433+ type Client t m (BasicAuth realm usr :> api) = Behavior t (Maybe BasicAuthData)
434+ -> Client t m api
565435
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
436+ clientWithRoute Proxy q req baseurl authdata =
437+ clientWithRoute (Proxy :: Proxy api) q req' baseurl
574438 where
575439 req' = req { authData = Just authdata }
576440
@@ -596,30 +460,3 @@ non-empty lists, but is otherwise more specific, no instance will be overall
596460more specific. This in turn generally means adding yet another instance (one
597461for empty and one for non-empty lists).
598462-}
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
625−