@@ -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 #-}
6+{-# LANGUAGE MultiParamTypeClasses #-}
9−{-# LANGUAGE OverloadedStrings #-}
7+{-# LANGUAGE OverloadedStrings #-}
10−{-# LANGUAGE PolyKinds #-}
8+{-# LANGUAGE PolyKinds #-}
11−{-# LANGUAGE Rank2Types #-}
12−{-# LANGUAGE ScopedTypeVariables #-}
9+{-# LANGUAGE ScopedTypeVariables #-}
13−{-# LANGUAGE TupleSections #-}
10+{-# LANGUAGE TupleSections #-}
14−{-# LANGUAGE TypeFamilies #-}
11+{-# LANGUAGE TypeFamilies #-}
15−{-# LANGUAGE TypeOperators #-}
12+{-# LANGUAGE TypeOperators #-}
16−{-# LANGUAGE UndecidableInstances #-}
13+{-# LANGUAGE UndecidableInstances #-}
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,47 @@
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−------------------------------------------------------------------------------
26+-------------------------------------------------------------------------------
41import Control.Applicative
27import Control.Applicative
42−import qualified Data.CaseInsensitive as CI
28+import Data.CaseInsensitive (mk)
43−import Data.Functor.Identity
44−import qualified Data.Map as Map
29+import qualified Data.Map as Map
45−import Data.Monoid ((<>))
30+import Data.Monoid ((<>))
46−import Data.Proxy (Proxy (..))
31+import Data.Proxy (Proxy (..))
47−import qualified Data.Set as Set
32+import qualified Data.Set as Set
48−import Data.Text (Text)
33+import Data.Text (Text)
49−import qualified Data.Text as T
34+import qualified Data.Text as T
50−import qualified Data.Text.Encoding as E
35+import qualified Data.Text.Encoding as E
51−import GHC.Exts (Constraint)
52−import GHC.TypeLits (KnownSymbol, symbolVal)
36+import GHC.TypeLits (KnownSymbol, symbolVal)
37+import Reflex.Dom (Dynamic, Event, Reflex,
38+ XhrRequest (..), XhrResponse (..),
39+ XhrResponseHeaders (..), ffor,
41+ performRequestAsync, tagPromptlyDyn)
53−import Servant.API ((:<|>) (..), (:>), BasicAuth,
42+import Servant.API ((:<|>) (..), (:>), BasicAuth,
54− BasicAuthData, BuildHeadersTo (..),
43+ BasicAuthData, BuildHeadersTo (..),
55− Capture, Header, Headers (..),
44+ Capture, Header, Headers (..),
56− HttpVersion, IsSecure,
45+ HttpVersion, IsSecure, MimeRender (..),
57− MimeRender (..), MimeUnrender,
58− NoContent, QueryFlag, QueryParam,
46+ MimeUnrender, NoContent, QueryFlag,
59− QueryParams, Raw, ReflectMethod (..),
47+ QueryParam, QueryParams, Raw,
60− RemoteHost, ReqBody,
48+ ReflectMethod (..), RemoteHost,
61− ToHttpApiData (..), Vault, Verb,
49+ ReqBody, ToHttpApiData (..), Vault,
62− contentType)
50+ Verb, contentType)
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−------------------------------------------------------------------------------
73−import Servant.Common.BaseUrl (BaseUrl(..), Scheme(..), baseUrlWidget,
51+import Servant.Common.BaseUrl (BaseUrl (..), Scheme (..),
52+ SupportsServantReflex, baseUrlWidget,
74− showBaseUrl,
53+ showBaseUrl)
75− SupportsServantReflex)
76−import Servant.Common.Req (ClientOptions(..),
54+import Servant.Common.Req (QParam (..), QueryPart (..), Req,
77− defaultClientOptions,
78− Req, ReqResult(..), QParam(..),
79− QueryPart(..), addHeader, authData,
55+ ReqResult (..), addHeader, authData,
80− defReq, evalResponse, prependToPathParts,
81− -- performRequestCT,
56+ defReq, performRequestCT,
83− -- performRequestNoBody,
57+ performRequestNoBody,
84− performRequestsNoBody,
85− performSomeRequestsAsync,
86− qParamToQueryPart, reqBody,
58+ prependToPathParts, qParamToQueryPart,
87− reqSuccess, reqFailure,
59+ qParams, reqBody, reqFailure,
88− reqMethod, respHeaders,
60+ reqMethod, reqSuccess, respHeaders,
89− response,
61+ response)
91− qParams, withCredentials)
94-- * Accessing APIs as a Client
63-- * Accessing APIs as a Client
@@ -101,78 +70,28 @@ import Servant.Common.Req (ClientOptions(..),
101-- > myApi :: Proxy MyApi
70-- > myApi :: Proxy MyApi
102-- > myApi = Proxy
71-- > myApi = Proxy
104−-- > getAllBooks :: Event t l -> m (Event t (l, ReqResult [Book]))
73+-- > getAllBooks :: Event t () -> m (Event t (Either XhrError ((),[Book])))
105−-- > postNewBook :: Dynamic t (Maybe Book) -> Event t l
74+-- > postNewBook :: Dynamic t (Maybe Book) -> Event t ()
106−-- > -> m (Event t (l, ReqResult Book)))
75+-- -> m (Event t (Either XhrError (Book,Book)))
107-- > (getAllBooks :<|> postNewBook) = client myApi host
76-- > (getAllBooks :<|> postNewBook) = client myApi host
108-- > where host = constDyn $ BaseUrl Http "localhost" 8080
77-- > where host = constDyn $ BaseUrl Http "localhost" 8080
110− :: (HasClient t m layout tag)
78+client :: (HasClient t m layout)
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
79+ => 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
80+client p q = clientWithRoute p q defReq
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
82-- | This class lets us define how each API combinator
144-- influences the creation of an HTTP request. It's mostly
83-- influences the creation of an HTTP request. It's mostly
145-- an internal class, you can just use 'client'.
84-- an internal class, you can just use 'client'.
146−class Monad m => HasClient t m layout (tag :: *) where
85+class HasClient t m layout where
147− type Client t m layout tag :: *
86+ type Client t m layout :: *
148− clientWithRoute
87+ 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
90+instance (HasClient t m a, HasClient t m b) => HasClient t m (a :<|> b) where
91+ type Client t m (a :<|> b) = Client t m a :<|> Client t m b
92+ clientWithRoute Proxy q req baseurl =
93+ clientWithRoute (Proxy :: Proxy a) q req baseurl :<|>
94+ clientWithRoute (Proxy :: Proxy b) q req baseurl
177-- Capture. Example:
96-- Capture. Example:
178-- > type MyApi = "books" :> Capture "isbn" Text :> Get '[JSON] Book
97-- > type MyApi = "books" :> Capture "isbn" Text :> Get '[JSON] Book
@@ -182,72 +101,67 @@ instance (HasClient t m a tag, HasClient t m b tag) => HasClient t m (a :<|> b)
182-- > getBook :: SupportsServantReflex t m
101-- > getBook :: SupportsServantReflex t m
183-- => Dynamic t BaseUrl
102-- => Dynamic t BaseUrl
184-- -> Dynamic t (Maybe Text)
103-- -> Dynamic t (Maybe Text)
185−-- -> Event t l
104+-- -> Event t ()
186−-- -> m (Event t (l, ReqResult Book))
105+-- -> m (Event t (Either XhrError (Text, Book)))
187-- > getBook = client myApi (constDyn host)
106-- > getBook = client myApi (constDyn host)
107+instance (SupportsServantReflex t m, ToHttpApiData a, HasClient t m sublayout)
108+ => 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
110+ type Client t m (Capture capture a :> sublayout) =
111+ Dynamic t (Either Text a) -> Client t m sublayout
192− type Client t m (Capture capture a :> sublayout) tag =
193− Dynamic t (Either Text a) -> Client t m sublayout tag
195− clientWithRouteAndResultHandler Proxy q t req baseurl opts wrap val =
113+ clientWithRoute Proxy q req baseurl val =
196− clientWithRouteAndResultHandler
114+ clientWithRoute (Proxy :: Proxy sublayout)
197− (Proxy :: Proxy sublayout) q t (prependToPathParts p req) baseurl opts wrap
116+ (prependToPathParts p req)
198− where p = (fmap . fmap) (toUrlPiece) val
117+ baseurl
119+ where p = (fmap . fmap) toUrlPiece val
201-- VERB (Returning content) --
121-- VERB (Returning content) --
202instance {-# OVERLAPPABLE #-}
122instance {-# OVERLAPPABLE #-}
203 -- Note [Non-Empty Content Types]
123 -- Note [Non-Empty Content Types]
204 (MimeUnrender ct a, ReflectMethod method, cts' ~ (ct ': cts), SupportsServantReflex t m
124 (MimeUnrender ct a, ReflectMethod method, cts' ~ (ct ': cts), SupportsServantReflex t m
205− ) => HasClient t m (Verb method status cts' a) tag where
125+ ) => HasClient t m (Verb method status cts' a) where
206− type Client t m (Verb method status cts' a) tag =
126+ type Client t m (Verb method status cts' a) =
207− Event t tag -> m (Event t (ReqResult tag a))
127+ Event t () -> m (Event t (ReqResult a))
208 -- TODO how to access input types here?
128 -- TODO how to access input types here?
209 -- ExceptT ServantError IO a
129 -- ExceptT ServantError IO a
210− clientWithRouteAndResultHandler Proxy _ _ req baseurl opts wrap trigs =
130+ clientWithRoute Proxy _ req =
211− wrap =<< fmap runIdentity <$> performRequestsCT (Proxy :: Proxy ct) method (constDyn $ Identity $ req') baseurl opts trigs
131+ performRequestCT (Proxy :: Proxy ct) method req'
212 where method = E.decodeUtf8 $ reflectMethod (Proxy :: Proxy method)
132 where method = E.decodeUtf8 $ reflectMethod (Proxy :: Proxy method)
213 req' = req { reqMethod = method }
133 req' = req { reqMethod = method }
216-- -- VERB (No content) --
135-- -- VERB (No content) --
217instance {-# OVERLAPPING #-}
136instance {-# OVERLAPPING #-}
218 (ReflectMethod method, SupportsServantReflex t m) =>
137 (ReflectMethod method, SupportsServantReflex t m) =>
219− HasClient t m (Verb method status cts NoContent) tag where
138+ HasClient t m (Verb method status cts NoContent) where
220− type Client t m (Verb method status cts NoContent) tag =
139+ type Client t m (Verb method status cts NoContent) =
221− Event t tag -> m (Event t (ReqResult tag NoContent))
140+ Event t () -> m (Event t (ReqResult NoContent))
222 -- TODO: how to access input types here?
141 -- TODO: how to access input types here?
223 -- ExceptT ServantError IO NoContent
142 -- ExceptT ServantError IO NoContent
224− clientWithRouteAndResultHandler Proxy _ _ req baseurl opts wrap trigs =
143+ clientWithRoute Proxy _ =
225− wrap =<< fmap runIdentity <$> performRequestsNoBody method (constDyn $ Identity req) baseurl opts trigs
144+ performRequestNoBody method
226 where method = E.decodeUtf8 $ reflectMethod (Proxy :: Proxy method)
145 where method = E.decodeUtf8 $ reflectMethod (Proxy :: Proxy method)
229−toHeaders :: BuildHeadersTo ls => ReqResult tag a -> ReqResult tag (Headers ls a)
147+toHeaders :: BuildHeadersTo ls => ReqResult a -> ReqResult (Headers ls a)
230toHeaders r =
148toHeaders r =
149+ let toBS = E.encodeUtf8
231− let hdrs = maybe []
150+ hdrs = maybe []
232− (\xhr -> fmap (\(h,v) -> (CI.map E.encodeUtf8 h, E.encodeUtf8 v))
151+ (\xhr -> fmap (\(h,v) -> (mk (toBS h), toBS v))
233 (Map.toList $ _xhrResponse_headers xhr))
152 (Map.toList $ _xhrResponse_headers xhr))
234 (response r)
153 (response r)
235 in ffor r $ \a -> Headers {getResponse = a ,getHeadersHList = buildHeadersTo hdrs}
154 in ffor r $ \a -> Headers {getResponse = a ,getHeadersHList = buildHeadersTo hdrs}
238class BuildHeaderKeysTo hs where
156class BuildHeaderKeysTo hs where
239− buildHeaderKeysTo :: Proxy hs -> [CI.CI T.Text]
157+ buildHeaderKeysTo :: Proxy hs -> [T.Text]
241instance {-# OVERLAPPABLE #-} BuildHeaderKeysTo '[]
159instance {-# OVERLAPPABLE #-} BuildHeaderKeysTo '[]
242 where buildHeaderKeysTo _ = []
160 where buildHeaderKeysTo _ = []
244instance {-# OVERLAPPABLE #-} (BuildHeaderKeysTo xs, KnownSymbol h)
162instance {-# OVERLAPPABLE #-} (BuildHeaderKeysTo xs, KnownSymbol h)
245 => BuildHeaderKeysTo ((Header h v) ': xs) where
163 => 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)
164+ buildHeaderKeysTo _ = T.pack (symbolVal (Proxy :: Proxy h)) : buildHeaderKeysTo (Proxy :: Proxy xs)
252-- HEADERS Verb (Content) --
166-- HEADERS Verb (Content) --
253-- Headers combinator not treated in fully general case,
167-- Headers combinator not treated in fully general case,
@@ -259,35 +173,33 @@ instance {-# OVERLAPPABLE #-}
259 ( MimeUnrender ct a, BuildHeadersTo ls, BuildHeaderKeysTo ls,
173 ( MimeUnrender ct a, BuildHeadersTo ls, BuildHeaderKeysTo ls,
260 ReflectMethod method, cts' ~ (ct ': cts),
174 ReflectMethod method, cts' ~ (ct ': cts),
261 SupportsServantReflex t m
175 SupportsServantReflex t m
262− ) => HasClient t m (Verb method status cts' (Headers ls a)) tag where
176+ ) => HasClient t m (Verb method status cts' (Headers ls a)) where
263− type Client t m (Verb method status cts' (Headers ls a)) tag =
177+ type Client t m (Verb method status cts' (Headers ls a)) =
264− Event t tag -> m (Event t (ReqResult tag (Headers ls a)))
178+ Event t () -> m (Event t (ReqResult (Headers ls a)))
265− clientWithRouteAndResultHandler Proxy _ _ req baseurl opts wrap trigs = do
179+ clientWithRoute Proxy _ req baseurl = do
266 let method = E.decodeUtf8 $ reflectMethod (Proxy :: Proxy method)
180 let method = E.decodeUtf8 $ reflectMethod (Proxy :: Proxy method)
267− resp <- fmap runIdentity <$> performRequestsCT (Proxy :: Proxy ct) method (constDyn $ Identity req') baseurl opts trigs
181+ resp <- performRequestCT (Proxy :: Proxy ct) method req' baseurl
268− wrap $ toHeaders <$> resp
182+ return $ (fmap . fmap) toHeaders resp
269 where req' = req { respHeaders =
183 where req' = req { respHeaders =
270 OnlyHeaders (Set.fromList (buildHeaderKeysTo (Proxy :: Proxy ls)))
184 OnlyHeaders (Set.fromList (buildHeaderKeysTo (Proxy :: Proxy ls)))
274-- HEADERS Verb (No content) --
187-- HEADERS Verb (No content) --
275instance {-# OVERLAPPABLE #-}
188instance {-# OVERLAPPABLE #-}
276 ( BuildHeadersTo ls, BuildHeaderKeysTo ls, ReflectMethod method,
189 ( BuildHeadersTo ls, BuildHeaderKeysTo ls, ReflectMethod method,
277 SupportsServantReflex t m
190 SupportsServantReflex t m
278− ) => HasClient t m (Verb method status cts (Headers ls NoContent)) tag where
191+ ) => HasClient t m (Verb method status cts (Headers ls NoContent)) where
279− type Client t m (Verb method status cts (Headers ls NoContent)) tag
192+ type Client t m (Verb method status cts (Headers ls NoContent))
280− = Event t tag -> m (Event t (ReqResult tag (Headers ls NoContent)))
193+ = Event t () -> m (Event t (ReqResult (Headers ls NoContent)))
281− clientWithRouteAndResultHandler Proxy _ _ req baseurl opts wrap trigs = do
194+ clientWithRoute Proxy _ req baseurl = do
282 let method = E.decodeUtf8 $ reflectMethod (Proxy :: Proxy method)
195 let method = E.decodeUtf8 $ reflectMethod (Proxy :: Proxy method)
283− resp <- fmap runIdentity <$> performRequestsNoBody method (constDyn $ Identity req') baseurl opts trigs
196+ resp <- performRequestNoBody method req' baseurl
284− wrap $ toHeaders <$> resp
197+ return $ (fmap . fmap) toHeaders resp
285 where req' = req {respHeaders =
198 where req' = req {respHeaders =
286 OnlyHeaders (Set.fromList (buildHeaderKeysTo (Proxy :: Proxy ls)))
199 OnlyHeaders (Set.fromList (buildHeaderKeysTo (Proxy :: Proxy ls)))
292-- > newtype Referer = Referer { referrer :: Text }
204-- > newtype Referer = Referer { referrer :: Text }
293-- > deriving (Eq, Show, Generic, FromText, ToHttpApiData)
205-- > deriving (Eq, Show, Generic, FromText, ToHttpApiData)
@@ -302,45 +214,28 @@ instance {-# OVERLAPPABLE #-}
302-- > -- then you can just use "viewRefer" to query that endpoint
214-- > -- then you can just use "viewRefer" to query that endpoint
303-- > -- specifying Nothing or e.g Just "http://haskell.org/" as arguments
215-- > -- specifying Nothing or e.g Just "http://haskell.org/" as arguments
304instance (KnownSymbol sym, ToHttpApiData a,
216instance (KnownSymbol sym, ToHttpApiData a,
305− HasClient t m sublayout tag, SupportsServantReflex t m)
217+ HasClient t m sublayout, SupportsServantReflex t m)
306− => HasClient t m (Header sym a :> sublayout) tag where
218+ => HasClient t m (Header sym a :> sublayout) where
308− type Client t m (Header sym a :> sublayout) tag =
220+ type Client t m (Header sym a :> sublayout) =
309− Dynamic t (Either Text a) -> Client t m sublayout tag
221+ Dynamic t (Either Text a) -> Client t m sublayout
311− clientWithRouteAndResultHandler Proxy q t req baseurl opts wrap eVal =
223+ clientWithRoute Proxy q req baseurl eVal =
312− clientWithRouteAndResultHandler
313− (Proxy :: Proxy sublayout) q t
224+ clientWithRoute (Proxy :: Proxy sublayout)
314− (Servant.Common.Req.addHeader hname eVal req)
226+ (Servant.Common.Req.addHeader hname eVal req)
315− baseurl opts wrap
227+ baseurl
316 where hname = T.pack $ symbolVal (Proxy :: Proxy sym)
228 where hname = T.pack $ symbolVal (Proxy :: Proxy sym)
321-- | Using a 'HttpVersion' combinator in your API doesn't affect the client
230-- | Using a 'HttpVersion' combinator in your API doesn't affect the client
322-- functions.
231-- functions.
323−instance HasClient t m sublayout tag
232+instance HasClient t m sublayout
324− => HasClient t m (HttpVersion :> sublayout) tag where
233+ => 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)
235+ type Client t m (HttpVersion :> sublayout) =
236+ Client t m sublayout
238+ clientWithRoute Proxy = clientWithRoute (Proxy :: Proxy sublayout)
346-- | If you use a 'QueryParam' in one of your endpoints in your API,
241-- | If you use a 'QueryParam' in one of your endpoints in your API,
@@ -369,16 +264,16 @@ instance (HasClient t m sublayout tag, KnownSymbol sym)
369-- > -- then you can just use "getBooksBy" to query that endpoint.
264-- > -- then you can just use "getBooksBy" to query that endpoint.
370-- > -- 'getBooksBy Nothing' for all books
265-- > -- 'getBooksBy Nothing' for all books
371-- > -- 'getBooksBy (Just "Isaac Asimov")' to get all books by Isaac Asimov
266-- > -- 'getBooksBy (Just "Isaac Asimov")' to get all books by Isaac Asimov
372−instance (KnownSymbol sym, ToHttpApiData a, HasClient t m sublayout tag, Reflex t)
267+instance (KnownSymbol sym, ToHttpApiData a, HasClient t m sublayout, Reflex t)
373− => HasClient t m (QueryParam sym a :> sublayout) tag where
268+ => HasClient t m (QueryParam sym a :> sublayout) where
375− type Client t m (QueryParam sym a :> sublayout) tag =
270+ type Client t m (QueryParam sym a :> sublayout) =
376− Dynamic t (QParam a) -> Client t m sublayout tag
271+ Dynamic t (QParam a) -> Client t m sublayout
378 -- if mparam = Nothing, we don't add it to the query string
273 -- if mparam = Nothing, we don't add it to the query string
379− clientWithRouteAndResultHandler Proxy q t req baseurl opts wrap mparam =
274+ clientWithRoute Proxy q req baseurl mparam =
380− clientWithRouteAndResultHandler (Proxy :: Proxy sublayout) q t
275+ clientWithRoute (Proxy :: Proxy sublayout) q
381− (req {qParams = paramPair : qParams req}) baseurl opts wrap
276+ (req {qParams = paramPair : qParams req}) baseurl
383 where pname = symbolVal (Proxy :: Proxy sym)
278 where pname = symbolVal (Proxy :: Proxy sym)
384 --p prm = QueryPartParam $ (fmap . fmap) (toQueryParam) prm
279 --p prm = QueryPartParam $ (fmap . fmap) (toQueryParam) prm
@@ -386,8 +281,6 @@ instance (KnownSymbol sym, ToHttpApiData a, HasClient t m sublayout tag, Reflex
386 p prm = QueryPartParam $ fmap qParamToQueryPart prm -- (fmap . fmap) (unpack . toQueryParam) prm
281 p prm = QueryPartParam $ fmap qParamToQueryPart prm -- (fmap . fmap) (unpack . toQueryParam) prm
387 paramPair = (T.pack pname, p mparam)
282 paramPair = (T.pack pname, p mparam)
391-- | If you use a 'QueryParams' in one of your endpoints in your API,
284-- | If you use a 'QueryParams' in one of your endpoints in your API,
392-- the corresponding querying function will automatically take
285-- the corresponding querying function will automatically take
393-- an additional argument, a list of values of the type specified
286-- an additional argument, a list of values of the type specified
@@ -416,14 +309,14 @@ instance (KnownSymbol sym, ToHttpApiData a, HasClient t m sublayout tag, Reflex
416-- > -- 'getBooksBy []' for all books
309-- > -- 'getBooksBy []' for all books
417-- > -- 'getBooksBy ["Isaac Asimov", "Robert A. Heinlein"]'
310-- > -- 'getBooksBy ["Isaac Asimov", "Robert A. Heinlein"]'
418-- > -- to get all books by Asimov and Heinlein
311-- > -- to get all books by Asimov and Heinlein
419−instance (KnownSymbol sym, ToHttpApiData a, HasClient t m sublayout tag, Reflex t)
312+instance (KnownSymbol sym, ToHttpApiData a, HasClient t m sublayout, Reflex t)
420− => HasClient t m (QueryParams sym a :> sublayout) tag where
313+ => HasClient t m (QueryParams sym a :> sublayout) where
422− type Client t m (QueryParams sym a :> sublayout) tag =
315+ type Client t m (QueryParams sym a :> sublayout) =
423− Dynamic t [a] -> Client t m sublayout tag
316+ Dynamic t [a] -> Client t m sublayout
425− clientWithRouteAndResultHandler Proxy q t req baseurl opts wrap paramlist =
318+ clientWithRoute Proxy q req baseurl paramlist =
426− clientWithRouteAndResultHandler (Proxy :: Proxy sublayout) q t req' baseurl opts wrap
319+ clientWithRoute (Proxy :: Proxy sublayout) q req' baseurl
428 where req' = req { qParams = (T.pack pname, params') : qParams req }
321 where req' = req { qParams = (T.pack pname, params') : qParams req }
429 pname = symbolVal (Proxy :: Proxy sym)
322 pname = symbolVal (Proxy :: Proxy sym)
@@ -431,7 +324,6 @@ instance (KnownSymbol sym, ToHttpApiData a, HasClient t m sublayout tag, Reflex
431 paramlist
324 paramlist
435-- | If you use a 'QueryFlag' in one of your endpoints in your API,
327-- | If you use a 'QueryFlag' in one of your endpoints in your API,
436-- the corresponding querying function will automatically take
328-- the corresponding querying function will automatically take
437-- an additional 'Bool' argument.
329-- an additional 'Bool' argument.
@@ -456,42 +348,49 @@ instance (KnownSymbol sym, ToHttpApiData a, HasClient t m sublayout tag, Reflex
456-- > -- 'getBooksBy True' to only get _already published_ books
348-- > -- 'getBooksBy True' to only get _already published_ books
458-- TODO Bring back
350-- TODO Bring back
459−instance (KnownSymbol sym, HasClient t m sublayout tag, Reflex t)
351+instance (KnownSymbol sym, HasClient t m sublayout, Reflex t)
460− => HasClient t m (QueryFlag sym :> sublayout) tag where
352+ => HasClient t m (QueryFlag sym :> sublayout) where
462− type Client t m (QueryFlag sym :> sublayout) tag =
354+ type Client t m (QueryFlag sym :> sublayout) =
463− Dynamic t Bool -> Client t m sublayout tag
355+ Dynamic t Bool -> Client t m sublayout
465− clientWithRouteAndResultHandler Proxy q t req baseurl opts wrap flag =
357+ clientWithRoute Proxy q req baseurl flag =
466− clientWithRouteAndResultHandler (Proxy :: Proxy sublayout) q t req' baseurl opts wrap
358+ clientWithRoute (Proxy :: Proxy sublayout) q req' baseurl
468 where req' = req { qParams = thisPair : qParams req }
360 where req' = req { qParams = thisPair : qParams req }
469 thisPair = (T.pack pName, QueryPartFlag flag) :: (Text, QueryPart t)
361 thisPair = (T.pack pName, QueryPartFlag flag) :: (Text, QueryPart t)
470 pName = symbolVal (Proxy :: Proxy sym)
362 pName = symbolVal (Proxy :: Proxy sym)
473−
365+-- | Pick a 'Method' and specify where the server you want to query is. You get
474−-- | Send a raw 'XhrRequest ()' directly to 'baseurl'
366+-- back the full `Response`.
475−instance SupportsServantReflex t m => HasClient t m Raw tag where
368+instance SupportsServantReflex t m => HasClient t m Raw where
476− type Client t m Raw tag = Dynamic t (Either Text (XhrRequest ()))
369+ type Client t m Raw = Dynamic t (Either Text (XhrRequest ()))
477− -> Event t tag
370+ -> Event t ()
478− -> m (Event t (ReqResult tag ()))
371+ -> m (Event t (ReqResult ()))
480− clientWithRouteAndResultHandler _ _ _ _ baseurl _ wrap xhrs triggers = do
373+ -- clientWithRoute :: Proxy Raw -> Proxy m -> Req -> BaseUrl -> Client t m Raw
481−
374+ clientWithRoute _ _ _ baseurl xhrs triggers = do
482− let xhrs' = liftA2 (\x path -> case x of
375+ let xhrs' = liftA2 (\x path -> case x of
483− Left e -> Left e
376+ Left e -> Left e
484− Right jx -> Right $ jx { _xhrRequest_url = path <> _xhrRequest_url jx }
377+ Right jx -> Right $ jx {_xhrRequest_url = path
378+ <> _xhrRequest_url jx})
485− ) xhrs (showBaseUrl <$> baseurl)
380+ (showBaseUrl <$> baseurl)
486− xhrs'' = attachPromptlyDynWith (flip (,)) xhrs' triggers :: Event t (tag, Either Text (XhrRequest ()))
381+ reqs = tagPromptlyDyn xhrs' triggers
487− badReq = fmapMaybe (\(t,x) -> either (Just . (t,)) (const Nothing) x) xhrs'' :: Event t (tag, Text)
382+ okReq = fmapMaybe hush reqs
488− okReq = fmapMaybe (\(t,x) -> either (const Nothing) (Just . (t,)) x) xhrs'' :: Event t (tag, XhrRequest ())
383+ badReq = fmapMaybe tattle reqs
489−
384+ resps <- performRequestAsync okReq
490− resps <- performRequestsAsync okReq
385+ return $ leftmost [fmap (ResponseSuccess () ) resps
491− wrap $ leftmost [ uncurry RequestFailure <$> badReq
386+ ,fmap RequestFailure badReq]
492− , evalResponse (const $ Right ()) <$> resps
387+
494−
389+hush :: Either e a -> Maybe a
390+hush = either (const Nothing) Just
392+tattle :: Either e a -> Maybe e
393+tattle = either Just (const Nothing)
496-- | If you use a 'ReqBody' in one of your endpoints in your API,
395-- | If you use a 'ReqBody' in one of your endpoints in your API,
497-- the corresponding querying function will automatically take
396-- the corresponding querying function will automatically take
@@ -513,14 +412,14 @@ instance SupportsServantReflex t m => HasClient t m Raw tag where
513-- > where host = BaseUrl Http "localhost" 8080
412-- > where host = BaseUrl Http "localhost" 8080
514-- > -- then you can just use "addBook" to query that endpoint
413-- > -- then you can just use "addBook" to query that endpoint
516−instance (MimeRender ct a, HasClient t m sublayout tag, Reflex t)
415+instance (MimeRender ct a, HasClient t m sublayout, Reflex t)
517− => HasClient t m (ReqBody (ct ': cts) a :> sublayout) tag where
416+ => HasClient t m (ReqBody (ct ': cts) a :> sublayout) where
519− type Client t m (ReqBody (ct ': cts) a :> sublayout) tag =
418+ type Client t m (ReqBody (ct ': cts) a :> sublayout) =
520− Dynamic t (Either Text a) -> Client t m sublayout tag
419+ Dynamic t (Either Text a) -> Client t m sublayout
522− clientWithRouteAndResultHandler Proxy q t req baseurl opts wrap body =
421+ clientWithRoute Proxy q req baseurl body =
523− clientWithRouteAndResultHandler (Proxy :: Proxy sublayout) q t req' baseurl opts wrap
422+ clientWithRoute (Proxy :: Proxy sublayout) q req' baseurl
524 where req' = req { reqBody = bodyBytesCT }
423 where req' = req { reqBody = bodyBytesCT }
525 ctProxy = Proxy :: Proxy ct
424 ctProxy = Proxy :: Proxy ct
526 ctString = T.pack $ show $ contentType ctProxy
425 ctString = T.pack $ show $ contentType ctProxy
@@ -528,49 +427,39 @@ instance (MimeRender ct a, HasClient t m sublayout tag, Reflex t)
528 (\b -> (mimeRender ctProxy b, ctString))
427 (\b -> (mimeRender ctProxy b, ctString))
533-- | Make the querying function append @path@ to the request path.
430-- | 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
431+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
432+ type Client t m (path :> sublayout) = Client t m sublayout
537− clientWithRouteAndResultHandler Proxy q t req baseurl opts wrap =
434+ clientWithRoute Proxy q req =
538− clientWithRouteAndResultHandler (Proxy :: Proxy sublayout) q t
435+ clientWithRoute (Proxy :: Proxy sublayout) q
539− (prependToPathParts (pure (Right $ T.pack p)) req) baseurl opts wrap
436+ (prependToPathParts (pure (Right $ T.pack p)) req)
541 where p = symbolVal (Proxy :: Proxy path)
438 where p = symbolVal (Proxy :: Proxy path)
440+instance HasClient t m api => HasClient t m (Vault :> api) where
441+ type Client t m (Vault :> api) = Client t m api
544−instance HasClient t m api tag => HasClient t m (Vault :> api) tag where
443+ clientWithRoute Proxy = clientWithRoute (Proxy :: Proxy api)
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)
445+instance HasClient t m api => HasClient t m (RemoteHost :> api) where
446+ type Client t m (RemoteHost :> api) = Client t m api
448+ clientWithRoute Proxy = clientWithRoute (Proxy :: Proxy api)
559−instance HasClient t m api tag => HasClient t m (IsSecure :> api) tag where
450+instance HasClient t m api => HasClient t m (IsSecure :> api) where
560− type Client t m (IsSecure :> api) tag = Client t m api tag
451+ type Client t m (IsSecure :> api) = Client t m api
562− clientWithRouteAndResultHandler Proxy =
453+ clientWithRoute Proxy = clientWithRoute (Proxy :: Proxy api)
563− clientWithRouteAndResultHandler (Proxy :: Proxy api)
455+instance (HasClient t m api, Reflex t)
456+ => HasClient t m (BasicAuth realm usr :> api) where
566−instance (HasClient t m api tag, Reflex t)
567− => HasClient t m (BasicAuth realm usr :> api) tag where
458+ type Client t m (BasicAuth realm usr :> api) = Dynamic t (Maybe BasicAuthData)
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 =
461+ clientWithRoute Proxy q req baseurl authdata =
573− clientWithRouteAndResultHandler (Proxy :: Proxy api) q t req' baseurl opts wrap
462+ clientWithRoute (Proxy :: Proxy api) q req' baseurl
575 req' = req { authData = Just authdata }
464 req' = req { authData = Just authdata }
@@ -596,30 +485,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
485more specific. This in turn generally means adding yet another instance (one
597for empty and one for non-empty lists).
486for 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