@@ -1,15 +1,23 @@
1−{-# LANGUAGE CPP #-}
1+{-# LANGUAGE AllowAmbiguousTypes #-}
2−{-# LANGUAGE DataKinds #-}
3+{-# LANGUAGE DataKinds #-}
3−{-# LANGUAGE FlexibleContexts #-}
4+{-# LANGUAGE FlexibleContexts #-}
4−{-# LANGUAGE FlexibleInstances #-}
5+{-# LANGUAGE FlexibleInstances #-}
6+{-# LANGUAGE GeneralizedNewtypeDeriving #-}
5−{-# LANGUAGE InstanceSigs #-}
7+{-# LANGUAGE InstanceSigs #-}
8+{-# LANGUAGE MultiParamTypeClasses #-}
6−{-# LANGUAGE OverloadedStrings #-}
9+{-# LANGUAGE OverloadedStrings #-}
7−{-# LANGUAGE PolyKinds #-}
10+{-# LANGUAGE PolyKinds #-}
11+{-# LANGUAGE Rank2Types #-}
8−{-# LANGUAGE ScopedTypeVariables #-}
12+{-# LANGUAGE ScopedTypeVariables #-}
13+{-# LANGUAGE TupleSections #-}
9−{-# LANGUAGE TypeFamilies #-}
14+{-# LANGUAGE TypeFamilies #-}
10−{-# LANGUAGE TypeOperators #-}
15+{-# LANGUAGE TypeOperators #-}
11−{-# LANGUAGE UndecidableInstances #-}
16+{-# LANGUAGE UndecidableInstances #-}
12−{-# LANGUAGE MultiParamTypeClasses #-}
17+
18+#if MIN_VERSION_base(4,9,0)
19+{-# OPTIONS_GHC -fno-warn-redundant-constraints #-}
14-- #include "overlapping-compat.h"
22-- #include "overlapping-compat.h"
15-- | This module provides 'client' which can automatically generate
23-- | This module provides 'client' which can automatically generate
@@ -17,28 +25,71 @@
18module Servant.Reflex
26module Servant.Reflex
29+ , clientWithOptsAndResultHandler
31+ , clientWithRouteAndResultHandler
32+ , BuildHeaderKeysTo(..)
20− , HasClient(..)
34+ , HasClient
21− , ServantError(..)
35+ , Client
36+ , module Servant.Common.Req
22 , module Servant.Common.BaseUrl
37 , module Servant.Common.BaseUrl
40+------------------------------------------------------------------------------
25−import Control.Applicative ((<$>))
41+import Control.Applicative
26−import Control.Monad.Trans.Except
42+import qualified Data.CaseInsensitive as CI
43+import Data.Functor.Identity
44+import qualified Data.Map as Map
27−import Data.ByteString.Lazy (ByteString)
45+import Data.Monoid ((<>))
28−import Data.List
46+import Data.Proxy (Proxy (..))
29−import Data.Proxy
47+import qualified Data.Set as Set
30−import Data.String.Conversions
48+import Data.Text (Text)
49+import qualified Data.Text as T
31−import Data.Text (unpack)
50+import qualified Data.Text.Encoding as E
51+import GHC.Exts (Constraint)
32−import GHC.TypeLits
52+import GHC.TypeLits (KnownSymbol, symbolVal)
33−-- import Network.HTTP.Media
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 (..),
61+ ToHttpApiData (..), Vault, Verb,
63+import Servant.API.Description (Summary)
34−-- import qualified Network.HTTP.Types as H
64+import qualified Servant.Auth as Auth
35−-- import qualified Network.HTTP.Types.Header as HTTP
65+
36−import Servant.API
66+import Reflex.Dom.Core (Dynamic, Event, Reflex,
37−import Servant.Common.BaseUrl
67+ XhrRequest (..), XhrResponse (..),
68+ XhrResponseHeaders (..),
69+ attachPromptlyDynWith, constDyn, ffor,
71+ performRequestsAsync)
72+------------------------------------------------------------------------------
73+import Servant.Common.BaseUrl (BaseUrl(..), Scheme(..), baseUrlWidget,
75+ SupportsServantReflex)
38−import Servant.Common.Req
76+import Servant.Common.Req (ClientOptions(..),
39−import Reflex
77+ defaultClientOptions,
40−import Reflex.Dom
78+ Req, ReqResult(..), QParam(..),
41−import Reflex.Dom.Xhr
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)
43-- * Accessing APIs as a Client
94-- * Accessing APIs as a Client
@@ -50,113 +101,193 @@ import Reflex.Dom.Xhr
50-- > myApi :: Proxy MyApi
101-- > myApi :: Proxy MyApi
51-- > myApi = Proxy
102-- > myApi = Proxy
53−-- > getAllBooks :: Event t () -> m (Event t (Either XhrError ((),[Book])))
104+-- > getAllBooks :: Event t l -> m (Event t (l, ReqResult [Book]))
54−-- > postNewBook :: Behavior t (Maybe Book) -> Event t ()
105+-- > postNewBook :: Dynamic t (Maybe Book) -> Event t l
55−-- -> m (Event t (Either XhrError (Book,Book)))
106+-- > -> m (Event t (l, ReqResult Book)))
56-- > (getAllBooks :<|> postNewBook) = client myApi host
107-- > (getAllBooks :<|> postNewBook) = client myApi host
57-- > where host = constDyn $ BaseUrl Http "localhost" 8080
108-- > where host = constDyn $ BaseUrl Http "localhost" 8080
58−client :: (HasClient t m layout) => Proxy layout -> Dynamic t BaseUrl -> Client t m layout
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
125+ -> Client t m layout tag
59−client p baseurl = clientWithRoute p defReq baseurl
126+clientWithOpts p q t baseurl = clientWithRoute p q t defReq baseurl
128+-- | Like 'clientWithOpts' but allows passing a function which will process the
129+-- result event in some way. This can be used to handle errors in a uniform way
130+-- across call sites.
131+clientWithOptsAndResultHandler
132+ :: (HasClient t m layout tag)
136+ -> Dynamic t BaseUrl
138+ -> (forall a. Event t (ReqResult tag a) -> m (Event t (ReqResult tag a)))
139+ -> Client t m layout tag
140+clientWithOptsAndResultHandler p q t = clientWithRouteAndResultHandler p q t defReq
61-- | This class lets us define how each API combinator
143-- | This class lets us define how each API combinator
62-- influences the creation of an HTTP request. It's mostly
144-- influences the creation of an HTTP request. It's mostly
63-- an internal class, you can just use 'client'.
145-- an internal class, you can just use 'client'.
64−class HasClient t m layout where
146+class Monad m => HasClient t m layout (tag :: *) where
65− type Client t m layout :: *
147+ type Client t m layout tag :: *
66− clientWithRoute :: Proxy layout -> Req t -> BaseUrl -> Client t m layout
148+ clientWithRoute
153+ -> Dynamic t BaseUrl
155+ -> Client t m layout tag
156+ clientWithRoute l m t r b o = clientWithRouteAndResultHandler l m t r b o return
158+ clientWithRouteAndResultHandler
163+ -> Dynamic t BaseUrl
165+ -> (forall a. Event t (ReqResult tag a) -> m (Event t (ReqResult tag a)))
166+ -> Client t m layout tag
169+instance (HasClient t m a tag, HasClient t m b tag) => HasClient t m (a :<|> b) tag where
170+ type Client t m (a :<|> b) tag = Client t m a tag :<|> Client t m b tag
172+ clientWithRouteAndResultHandler Proxy q pTag req baseurl opts wrap =
173+ clientWithRouteAndResultHandler (Proxy :: Proxy a) q pTag req baseurl opts wrap :<|>
174+ clientWithRouteAndResultHandler (Proxy :: Proxy b) q pTag req baseurl opts wrap
69−instance (HasClient t m a, HasClient t m b) => HasClient t m (a :<|> b) where
70− type Client t m (a :<|> b) = Client t m a :<|> Client t m b
71− clientWithRoute Proxy req baseurl =
72− clientWithRoute (Proxy :: Proxy a) req baseurl :<|>
73− clientWithRoute (Proxy :: Proxy b) req baseurl
75-- Capture. Example:
177-- Capture. Example:
76-- > type MyApi = "books" :> Capture "isbn" Text :> Get '[JSON] Book
178-- > type MyApi = "books" :> Capture "isbn" Text :> Get '[JSON] Book
78-- > myApi :: Proxy MyApi = Proxy
180-- > myApi :: Proxy MyApi = Proxy
80−-- > getBook :: MonadWidget t m
182+-- > getBook :: SupportsServantReflex t m
81-- => Dynamic t BaseUrl
183-- => Dynamic t BaseUrl
82−-- -> Behavior t (Maybe Text)
184+-- -> Dynamic t (Maybe Text)
83−-- -> Event t ()
185+-- -> Event t l
84−-- -> m (Event t (Either XhrError (Text, Book)))
186+-- -> m (Event t (l, ReqResult Book))
85-- > getBook = client myApi (constDyn host)
187-- > getBook = client myApi (constDyn host)
86−instance (MonadWidget t m, KnownSymbol capture, ToHttpApiData a, HasClient t m sublayout)
87− => 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
89− type Client t m (Capture capture a :> sublayout) =
192+ type Client t m (Capture capture a :> sublayout) tag =
90− Behavior t (Maybe a) -> Client t m sublayout
193+ Dynamic t (Either Text a) -> Client t m sublayout tag
92− clientWithRoute Proxy req baseurl val =
195+ clientWithRouteAndResultHandler Proxy q t req baseurl opts wrap val =
93− clientWithRoute (Proxy :: Proxy sublayout)
196+ clientWithRouteAndResultHandler
94− (prependToPathParts p req)
197+ (Proxy :: Proxy sublayout) q t (prependToPathParts p req) baseurl opts wrap
95− baseurl
198+ where p = (fmap . fmap) (toUrlPiece) val
97− where p = fmap (unpack . toUrlPiece) val
99-- VERB (Returning content) --
201-- VERB (Returning content) --
100instance {-# OVERLAPPABLE #-}
202instance {-# OVERLAPPABLE #-}
101 -- Note [Non-Empty Content Types]
203 -- Note [Non-Empty Content Types]
102− (MimeUnrender ct a, ReflectMethod method, cts' ~ (ct ': cts), MonadWidget t m
204+ (MimeUnrender ct a, ReflectMethod method, cts' ~ (ct ': cts), SupportsServantReflex t m
103− ) => HasClient t m (Verb method status cts' a) where
205+ ) => HasClient t m (Verb method status cts' a) tag where
104− type Client t m (Verb method status cts' a) =
206+ type Client t m (Verb method status cts' a) tag =
105− Event t () -> m (Event t (Maybe a, XhrResponse))
207+ Event t tag -> m (Event t (ReqResult tag a))
106 -- TODO how to access input types here?
208 -- TODO how to access input types here?
107 -- ExceptT ServantError IO a
209 -- ExceptT ServantError IO a
108− clientWithRoute Proxy req baseurl =
210+ clientWithRouteAndResultHandler Proxy _ _ req baseurl opts wrap trigs =
109− performRequestCT (Proxy :: Proxy ct) method req baseurl
211+ wrap =<< fmap runIdentity <$> performRequestsCT (Proxy :: Proxy ct) method (constDyn $ Identity $ req') baseurl opts trigs
110− where method = reflectMethod (Proxy :: Proxy method)
212+ where method = E.decodeUtf8 $ reflectMethod (Proxy :: Proxy method)
111−
213+ req' = req { reqMethod = method }
112−-- VERB (No content) --
216+-- -- VERB (No content) --
113−instance {-# OVERLAPPABLE #-}
217+instance {-# OVERLAPPING #-}
114− (ReflectMethod method, MonadWidget t m) =>
218+ (ReflectMethod method, SupportsServantReflex t m) =>
115− HasClient t m (Verb method status cts NoContent) where
219+ HasClient t m (Verb method status cts NoContent) tag where
116− type Client t m (Verb method status cts NoContent) =
220+ type Client t m (Verb method status cts NoContent) tag =
117− Event t () -> m (Event t XhrResponse)
221+ Event t tag -> m (Event t (ReqResult tag NoContent))
118 -- TODO: how to access input types here?
222 -- TODO: how to access input types here?
119 -- ExceptT ServantError IO NoContent
223 -- ExceptT ServantError IO NoContent
120− clientWithRoute Proxy req baseurl =
224+ clientWithRouteAndResultHandler Proxy _ _ req baseurl opts wrap trigs =
121− performRequestNoBody method req baseurl
225+ wrap =<< fmap runIdentity <$> performRequestsNoBody method (constDyn $ Identity req) baseurl opts trigs
122− where method = reflectMethod (Proxy :: Proxy method)
226+ where method = E.decodeUtf8 $ reflectMethod (Proxy :: Proxy method)
229+toHeaders :: BuildHeadersTo ls => ReqResult tag a -> ReqResult tag (Headers ls a)
232+ (\xhr -> fmap (\(h,v) -> (CI.map E.encodeUtf8 h, E.encodeUtf8 v))
233+ (Map.toList $ _xhrResponse_headers xhr))
235+ in ffor r $ \a -> Headers {getResponse = a ,getHeadersHList = buildHeadersTo hdrs}
238+class BuildHeaderKeysTo hs where
239+ buildHeaderKeysTo :: Proxy hs -> [CI.CI T.Text]
241+instance {-# OVERLAPPABLE #-} BuildHeaderKeysTo '[]
242+ where buildHeaderKeysTo _ = []
244+instance {-# OVERLAPPABLE #-} (BuildHeaderKeysTo xs, KnownSymbol h)
245+ => BuildHeaderKeysTo ((Header h v) ': xs) where
246+ buildHeaderKeysTo _ =
248+ thisKey = CI.mk $ T.pack (symbolVal (Proxy :: Proxy h))
249+ in thisKey : buildHeaderKeysTo (Proxy :: Proxy xs)
124-- HEADERS Verb (Content) --
252-- HEADERS Verb (Content) --
125-- Headers combinator not treated in fully general case,
253-- Headers combinator not treated in fully general case,
126-- in order to deny instances for (Headers ls (Capture "id" Int)),
254-- in order to deny instances for (Headers ls (Capture "id" Int)),
127-- a combinator that wouldn't make sense
255-- a combinator that wouldn't make sense
256+-- TODO Overlapping??
128instance {-# OVERLAPPABLE #-}
257instance {-# OVERLAPPABLE #-}
129 -- Note [Non-Empty Content Types]
258 -- Note [Non-Empty Content Types]
130− ( MimeUnrender ct a, BuildHeadersTo ls,
259+ ( MimeUnrender ct a, BuildHeadersTo ls, BuildHeaderKeysTo ls,
131 ReflectMethod method, cts' ~ (ct ': cts),
260 ReflectMethod method, cts' ~ (ct ': cts),
132− MonadWidget t m
261+ SupportsServantReflex t m
133− ) => HasClient t m (Verb method status cts' (Headers ls a)) where
262+ ) => HasClient t m (Verb method status cts' (Headers ls a)) tag where
134− type Client t m (Verb method status cts' (Headers ls a))
263+ type Client t m (Verb method status cts' (Headers ls a)) tag =
135− = Event t () -> m (Event t (Maybe a, XhrResponse))
264+ Event t tag -> m (Event t (ReqResult tag (Headers ls a)))
136− -- ExceptT ServantError IO (Headers ls a)
265+ clientWithRouteAndResultHandler Proxy _ _ req baseurl opts wrap trigs = do
137− clientWithRoute Proxy req baseurl = do
138− let method = reflectMethod (Proxy :: Proxy method)
266+ let method = E.decodeUtf8 $ reflectMethod (Proxy :: Proxy method)
139− (hdrs, resp) <- performRequestCT (Proxy :: Proxy ct) method req baseurl
267+ resp <- fmap runIdentity <$> performRequestsCT (Proxy :: Proxy ct) method (constDyn $ Identity req') baseurl opts trigs
140− return $ Headers { getResponse = resp
268+ wrap $ toHeaders <$> resp
141− , getHeadersHList = buildHeadersTo hdrs
269+ where req' = req { respHeaders =
270+ OnlyHeaders (Set.fromList (buildHeaderKeysTo (Proxy :: Proxy ls)))
144-- HEADERS Verb (No content) --
274-- HEADERS Verb (No content) --
145instance {-# OVERLAPPABLE #-}
275instance {-# OVERLAPPABLE #-}
146− ( BuildHeadersTo ls, ReflectMethod method,
276+ ( BuildHeadersTo ls, BuildHeaderKeysTo ls, ReflectMethod method,
147− MonadWidget t m
277+ SupportsServantReflex t m
148− ) => HasClient t m (Verb method status cts (Headers ls NoContent)) where
278+ ) => HasClient t m (Verb method status cts (Headers ls NoContent)) tag where
149− type Client t m (Verb method status cts (Headers ls NoContent))
279+ type Client t m (Verb method status cts (Headers ls NoContent)) tag
150− = Event t () -> m (Event t XhrResponse)
151− -- ExceptT ServantError IO (Headers ls NoContent)
280+ = Event t tag -> m (Event t (ReqResult tag (Headers ls NoContent)))
152− clientWithRoute Proxy req baseurl = do
281+ clientWithRouteAndResultHandler Proxy _ _ req baseurl opts wrap trigs = do
153− let method = reflectMethod (Proxy :: Proxy method)
282+ let method = E.decodeUtf8 $ reflectMethod (Proxy :: Proxy method)
154− hdrs <- performRequestNoBody method req baseurl
283+ resp <- fmap runIdentity <$> performRequestsNoBody method (constDyn $ Identity req') baseurl opts trigs
155− return $ Headers { getResponse = NoContent
284+ wrap $ toHeaders <$> resp
156− , getHeadersHList = buildHeadersTo hdrs
285+ where req' = req {respHeaders =
286+ OnlyHeaders (Set.fromList (buildHeaderKeysTo (Proxy :: Proxy ls)))
161-- > newtype Referer = Referer { referrer :: Text }
292-- > newtype Referer = Referer { referrer :: Text }
162-- > deriving (Eq, Show, Generic, FromText, ToHttpApiData)
293-- > deriving (Eq, Show, Generic, FromText, ToHttpApiData)
@@ -171,32 +302,46 @@ instance {-# OVERLAPPABLE #-}
171-- > -- then you can just use "viewRefer" to query that endpoint
302-- > -- then you can just use "viewRefer" to query that endpoint
172-- > -- specifying Nothing or e.g Just "http://haskell.org/" as arguments
303-- > -- specifying Nothing or e.g Just "http://haskell.org/" as arguments
173instance (KnownSymbol sym, ToHttpApiData a,
304instance (KnownSymbol sym, ToHttpApiData a,
174− HasClient t m sublayout, MonadWidget t m)
305+ HasClient t m sublayout tag, SupportsServantReflex t m)
175− => HasClient t m (Header sym a :> sublayout) where
306+ => HasClient t m (Header sym a :> sublayout) tag where
308+ type Client t m (Header sym a :> sublayout) tag =
309+ Dynamic t (Either Text a) -> Client t m sublayout tag
311+ clientWithRouteAndResultHandler Proxy q t req baseurl opts wrap eVal =
312+ clientWithRouteAndResultHandler
313+ (Proxy :: Proxy sublayout) q t
314+ (Servant.Common.Req.addHeader hname eVal req)
316+ where hname = T.pack $ symbolVal (Proxy :: Proxy sym)
177− type Client t m (Header sym a :> sublayout) =
178− Behavior t (Maybe a) -> Client t m sublayout
180− clientWithRoute Proxy req baseurl mval =
181− clientWithRoute (Proxy :: Proxy sublayout)
183− (\value -> Servant.Common.Req.addHeader hname value req)
188− where hname = symbolVal (Proxy :: Proxy sym)
190-- | Using a 'HttpVersion' combinator in your API doesn't affect the client
321-- | Using a 'HttpVersion' combinator in your API doesn't affect the client
191-- functions.
322-- functions.
192−instance HasClient t m sublayout
323+instance HasClient t m sublayout tag
193− => HasClient t m (HttpVersion :> sublayout) where
324+ => HasClient t m (HttpVersion :> sublayout) tag where
326+ type Client t m (HttpVersion :> sublayout) tag =
327+ Client t m sublayout tag
329+ clientWithRouteAndResultHandler Proxy =
330+ clientWithRouteAndResultHandler (Proxy :: Proxy sublayout)
332+-- | Using a 'Summary' combinator in your API doesn't affect the client
334+instance (HasClient t m sublayout tag, KnownSymbol sym)
335+ => HasClient t m (Summary sym :> sublayout) tag where
337+ type Client t m (Summary sym :> sublayout) tag =
338+ Client t m sublayout tag
340+ clientWithRouteAndResultHandler Proxy =
341+ clientWithRouteAndResultHandler (Proxy :: Proxy sublayout)
195− type Client t m (HttpVersion :> sublayout) =
196− Client t m sublayout
198− clientWithRoute Proxy =
199− clientWithRoute (Proxy :: Proxy sublayout)
201-- | If you use a 'QueryParam' in one of your endpoints in your API,
346-- | If you use a 'QueryParam' in one of your endpoints in your API,
202-- the corresponding querying function will automatically take
347-- the corresponding querying function will automatically take
@@ -224,22 +369,24 @@ instance HasClient t m sublayout
224-- > -- then you can just use "getBooksBy" to query that endpoint.
369-- > -- then you can just use "getBooksBy" to query that endpoint.
225-- > -- 'getBooksBy Nothing' for all books
370-- > -- 'getBooksBy Nothing' for all books
226-- > -- 'getBooksBy (Just "Isaac Asimov")' to get all books by Isaac Asimov
371-- > -- 'getBooksBy (Just "Isaac Asimov")' to get all books by Isaac Asimov
227−instance (KnownSymbol sym, ToHttpApiData a, HasClient t m sublayout)
372+instance (KnownSymbol sym, ToHttpApiData a, HasClient t m sublayout tag, Reflex t)
228− => HasClient t m (QueryParam sym a :> sublayout) where
373+ => HasClient t m (QueryParam sym a :> sublayout) tag where
230− type Client t m (QueryParam sym a :> sublayout) =
375+ type Client t m (QueryParam sym a :> sublayout) tag =
231− -- TODO (Maybe a), or (Maybe (Maybe a))? (should the user be able to send a Nothing)
232− Behavior t (Maybe a) -> Client t m sublayout
376+ Dynamic t (QParam a) -> Client t m sublayout tag
234 -- if mparam = Nothing, we don't add it to the query string
378 -- if mparam = Nothing, we don't add it to the query string
235− clientWithRoute Proxy req baseurl mparam =
379+ clientWithRouteAndResultHandler Proxy q t req baseurl opts wrap mparam =
236− clientWithRoute (Proxy :: Proxy sublayout)
380+ clientWithRouteAndResultHandler (Proxy :: Proxy sublayout) q t
237− (req {qParams = (pname', map show mparam) : qParams req})
381+ (req {qParams = paramPair : qParams req}) baseurl opts wrap
383+ where pname = symbolVal (Proxy :: Proxy sym)
384+ --p prm = QueryPartParam $ (fmap . fmap) (toQueryParam) prm
385+ --paramPair = (T.pack pname, p mparam)
386+ p prm = QueryPartParam $ fmap qParamToQueryPart prm -- (fmap . fmap) (unpack . toQueryParam) prm
387+ paramPair = (T.pack pname, p mparam)
240− where pname = cs pname'
241− pname' = symbolVal (Proxy :: Proxy sym)
242− mparamText = fmap toQueryParam mparam
244-- | If you use a 'QueryParams' in one of your endpoints in your API,
391-- | If you use a 'QueryParams' in one of your endpoints in your API,
245-- the corresponding querying function will automatically take
392-- the corresponding querying function will automatically take
@@ -269,23 +416,21 @@ instance (KnownSymbol sym, ToHttpApiData a, HasClient t m sublayout)
269-- > -- 'getBooksBy []' for all books
416-- > -- 'getBooksBy []' for all books
270-- > -- 'getBooksBy ["Isaac Asimov", "Robert A. Heinlein"]'
417-- > -- 'getBooksBy ["Isaac Asimov", "Robert A. Heinlein"]'
271-- > -- to get all books by Asimov and Heinlein
418-- > -- to get all books by Asimov and Heinlein
272−instance (KnownSymbol sym, ToHttpApiData a, HasClient t m sublayout)
419+instance (KnownSymbol sym, ToHttpApiData a, HasClient t m sublayout tag, Reflex t)
273− => HasClient t m (QueryParams sym a :> sublayout) where
420+ => HasClient t m (QueryParams sym a :> sublayout) tag where
422+ type Client t m (QueryParams sym a :> sublayout) tag =
423+ Dynamic t [a] -> Client t m sublayout tag
275− type Client t m (QueryParams sym a :> sublayout) =
425+ clientWithRouteAndResultHandler Proxy q t req baseurl opts wrap paramlist =
276− [a] -> Client t m sublayout
426+ clientWithRouteAndResultHandler (Proxy :: Proxy sublayout) q t req' baseurl opts wrap
428+ where req' = req { qParams = (T.pack pname, params') : qParams req }
429+ pname = symbolVal (Proxy :: Proxy sym)
430+ params' = QueryPartParams $ (fmap . fmap) toQueryParam
278− clientWithRoute Proxy req baseurl paramlist =
279− clientWithRoute (Proxy :: Proxy sublayout)
280− (foldl' (\ req' -> maybe req' (flip (appendToQueryString pname) req' . Just))
286− where pname = cs pname'
287− pname' = symbolVal (Proxy :: Proxy sym)
288− paramlist' = map (Just . toQueryParam) paramlist
290-- | If you use a 'QueryFlag' in one of your endpoints in your API,
435-- | If you use a 'QueryFlag' in one of your endpoints in your API,
291-- the corresponding querying function will automatically take
436-- the corresponding querying function will automatically take
@@ -309,32 +454,44 @@ instance (KnownSymbol sym, ToHttpApiData a, HasClient t m sublayout)
309-- > -- then you can just use "getBooks" to query that endpoint.
454-- > -- then you can just use "getBooks" to query that endpoint.
310-- > -- 'getBooksBy False' for all books
455-- > -- 'getBooksBy False' for all books
311-- > -- 'getBooksBy True' to only get _already published_ books
456-- > -- 'getBooksBy True' to only get _already published_ books
312−instance (KnownSymbol sym, HasClient t m sublayout)
313− => HasClient t m (QueryFlag sym :> sublayout) where
459+instance (KnownSymbol sym, HasClient t m sublayout tag, Reflex t)
460+ => HasClient t m (QueryFlag sym :> sublayout) tag where
315− type Client t m (QueryFlag sym :> sublayout) =
462+ type Client t m (QueryFlag sym :> sublayout) tag =
316− Bool -> Client t m sublayout
463+ Dynamic t Bool -> Client t m sublayout tag
465+ clientWithRouteAndResultHandler Proxy q t req baseurl opts wrap flag =
466+ clientWithRouteAndResultHandler (Proxy :: Proxy sublayout) q t req' baseurl opts wrap
468+ where req' = req { qParams = thisPair : qParams req }
469+ thisPair = (T.pack pName, QueryPartFlag flag) :: (Text, QueryPart t)
470+ pName = symbolVal (Proxy :: Proxy sym)
318− clientWithRoute Proxy req baseurl flag =
319− clientWithRoute (Proxy :: Proxy sublayout)
321− then appendToQueryString paramname Nothing req
326− where paramname = cs $ symbolVal (Proxy :: Proxy sym)
474+-- | Send a raw 'XhrRequest ()' directly to 'baseurl'
475+instance SupportsServantReflex t m => HasClient t m Raw tag where
476+ type Client t m Raw tag = Dynamic t (Either Text (XhrRequest ()))
478+ -> m (Event t (ReqResult tag ()))
329−-- | Pick a 'Method' and specify where the server you want to query is. You get
480+ clientWithRouteAndResultHandler _ _ _ _ baseurl _ wrap xhrs triggers = do
330−-- back the full `Response`.
481+
331−-- TODO redo
482+ let xhrs' = liftA2 (\x path -> case x of
332−-- instance HasClient Raw where
483+ Left e -> Left e
333−-- type Client Raw = String -> ExceptT ServantError IO (Int, ByteString, MediaType, [HTTP.Header], Response ByteString)
484+ Right jx -> Right $ jx { _xhrRequest_url = path <> _xhrRequest_url jx }
485+ ) xhrs (showBaseUrl <$> baseurl)
486+ xhrs'' = attachPromptlyDynWith (flip (,)) xhrs' triggers :: Event t (tag, Either Text (XhrRequest ()))
487+ badReq = fmapMaybe (\(t,x) -> either (Just . (t,)) (const Nothing) x) xhrs'' :: Event t (tag, Text)
488+ okReq = fmapMaybe (\(t,x) -> either (const Nothing) (Just . (t,)) x) xhrs'' :: Event t (tag, XhrRequest ())
490+ resps <- performRequestsAsync okReq
491+ wrap $ leftmost [ uncurry RequestFailure <$> badReq
492+ , evalResponse (const $ Right ()) <$> resps
335−-- clientWithRoute :: Proxy Raw -> Req -> BaseUrl -> Client Raw
336−-- clientWithRoute Proxy req baseurl httpMethod = do
337−-- performRequest httpMethod req baseurl
339-- | If you use a 'ReqBody' in one of your endpoints in your API,
496-- | If you use a 'ReqBody' in one of your endpoints in your API,
340-- the corresponding querying function will automatically take
497-- the corresponding querying function will automatically take
@@ -352,58 +509,76 @@ instance (KnownSymbol sym, HasClient t m sublayout)
352-- > myApi = Proxy
509-- > myApi = Proxy
354-- > addBook :: Book -> ExceptT String IO Book
511-- > addBook :: Book -> ExceptT String IO Book
355−-- > addBook = client myApi host
512+-- > addBook = client myApi host
356-- > where host = BaseUrl Http "localhost" 8080
513-- > where host = BaseUrl Http "localhost" 8080
357-- > -- then you can just use "addBook" to query that endpoint
514-- > -- then you can just use "addBook" to query that endpoint
358−instance (MimeRender ct a, HasClient t m sublayout)
359− => HasClient t m (ReqBody (ct ': cts) a :> sublayout) where
516+instance (MimeRender ct a, HasClient t m sublayout tag, Reflex t)
517+ => HasClient t m (ReqBody (ct ': cts) a :> sublayout) tag where
361− type Client t m (ReqBody (ct ': cts) a :> sublayout) =
519+ type Client t m (ReqBody (ct ': cts) a :> sublayout) tag =
362− a -> Client sublayout
520+ Dynamic t (Either Text a) -> Client t m sublayout tag
522+ clientWithRouteAndResultHandler Proxy q t req baseurl opts wrap body =
523+ clientWithRouteAndResultHandler (Proxy :: Proxy sublayout) q t req' baseurl opts wrap
524+ where req' = req { reqBody = bodyBytesCT }
525+ ctProxy = Proxy :: Proxy ct
526+ ctString = T.pack $ show $ contentType ctProxy
527+ bodyBytesCT = Just $ (fmap . fmap)
528+ (\b -> (mimeRender ctProxy b, ctString))
364− clientWithRoute Proxy req baseurl body =
365− clientWithRoute (Proxy :: Proxy sublayout)
366− (let ctProxy = Proxy :: Proxy ct
367− in setRQBody (mimeRender ctProxy body)
368− (contentType ctProxy)
373-- | Make the querying function append @path@ to the request path.
533-- | Make the querying function append @path@ to the request path.
374−instance (KnownSymbol path, HasClient t m sublayout) => HasClient t m (path :> sublayout) where
534+instance (KnownSymbol path, HasClient t m sublayout tag, Reflex t) => HasClient t m (path :> sublayout) tag where
375− type Client t m (path :> sublayout) = Client t m sublayout
535+ type Client t m (path :> sublayout) tag = Client t m sublayout tag
377− clientWithRoute Proxy req baseurl =
537+ clientWithRouteAndResultHandler Proxy q t req baseurl opts wrap =
378− clientWithRoute (Proxy :: Proxy sublayout)
538+ clientWithRouteAndResultHandler (Proxy :: Proxy sublayout) q t
379− (prependToPath (constant p) req)
539+ (prependToPathParts (pure (Right $ T.pack p)) req) baseurl opts wrap
382 where p = symbolVal (Proxy :: Proxy path)
541 where p = symbolVal (Proxy :: Proxy path)
384−instance HasClient t m api => HasClient t m (Vault :> api) where
385− type Client t m (Vault :> api) = Client api
387− clientWithRoute Proxy req baseurl =
544+instance HasClient t m api tag => HasClient t m (Vault :> api) tag where
388− clientWithRoute (Proxy :: Proxy api) req baseurl
545+ type Client t m (Vault :> api) tag = Client t m api tag
547+ clientWithRouteAndResultHandler Proxy =
548+ clientWithRouteAndResultHandler (Proxy :: Proxy api)
551+instance HasClient t m api tag => HasClient t m (RemoteHost :> api) tag where
552+ type Client t m (RemoteHost :> api) tag = Client t m api tag
554+ clientWithRouteAndResultHandler Proxy =
555+ clientWithRouteAndResultHandler (Proxy :: Proxy api)
390−instance HasClient t m api => HasClient t m (RemoteHost :> api) where
391− type Client t m (RemoteHost :> api) = Client t m api
393− clientWithRoute Proxy req baseurl =
559+instance HasClient t m api tag => HasClient t m (IsSecure :> api) tag where
394− clientWithRoute (Proxy :: Proxy api) req baseurl
560+ type Client t m (IsSecure :> api) tag = Client t m api tag
396−instance HasClient t m api => HasClient t m (IsSecure :> api) where
562+ clientWithRouteAndResultHandler Proxy =
397− type Client t m (IsSecure :> api) = Client t m api
563+ clientWithRouteAndResultHandler (Proxy :: Proxy api)
399− clientWithRoute Proxy req baseurl =
400− clientWithRoute (Proxy :: Proxy api) req baseurl
402−instance HasClient t m subapi =>
566+instance (HasClient t m api tag, Reflex t)
403− HasClient t m (WithNamedConfig name config subapi) where
567+ => HasClient t m (BasicAuth realm usr :> api) tag where
569+ type Client t m (BasicAuth realm usr :> api) tag = Dynamic t (Maybe BasicAuthData)
570+ -> Client t m api tag
572+ clientWithRouteAndResultHandler Proxy q t req baseurl opts wrap authdata =
573+ clientWithRouteAndResultHandler (Proxy :: Proxy api) q t req' baseurl opts wrap
575+ req' = req { authData = Just authdata }
577+-- instance HasClient t m subapi =>
578+-- HasClient t m (WithNamedConfig name config subapi) where
405− type Client t m (WithNamedConfig name config subapi) = Client t m subapi
580+-- type Client t m (WithNamedConfig name config subapi) = Client t m subapi
406− clientWithRoute Proxy = clientWithRoute (Proxy :: Proxy subapi)
581+-- clientWithRoute Proxy q = clientWithRoute (Proxy :: Proxy subapi) q
409{- Note [Non-Empty Content Types]
584{- Note [Non-Empty Content Types]
@@ -421,3 +596,30 @@ non-empty lists, but is otherwise more specific, no instance will be overall
421more specific. This in turn generally means adding yet another instance (one
596more specific. This in turn generally means adding yet another instance (one
422for empty and one for non-empty lists).
597for empty and one for non-empty lists).
601+-- SUPPORT FOR servant-auth --
603+-- For JavaScript clients we should be sending/storing JSON web tokens in a
604+-- way that is inaccessible to JavaScript.
606+-- For @servant-auth@ this is done with HTTP-only cookies. In a Reflex-DOM
607+-- app this means the @servant-auth@ client should only verify that the API
608+-- supports Cookie-based authentication but do nothing with the token
611+-- @HasCookieAuth auths@ is nominally a redundant constraint, but ensures
612+-- we're not trying to rely on cookies when the API does not use them.
613+instance (HasCookieAuth auths, HasClient t m api tag) => HasClient t m (Auth.Auth auths a :> api) tag where
615+ type Client t m (Auth.Auth auths a :> api) tag = Client t m api tag
616+ clientWithRouteAndResultHandler Proxy = clientWithRouteAndResultHandler (Proxy :: Proxy api)
619+type family HasCookieAuth xs :: Constraint where
620+ HasCookieAuth (Auth.Cookie ': xs) = ()
621+ HasCookieAuth (x ': xs) = HasCookieAuth xs
622+ HasCookieAuth '[] = CookieAuthNotEnabled
624+class CookieAuthNotEnabled