@@ -1,16 +1,23 @@
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 #-}
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
1421
1522-- #include "overlapping-compat.h"
1623-- | This module provides 'client' which can automatically generate
@@ -18,31 +25,71 @@
1825-- API.
1926module Servant.Reflex
2027 ( client
21− , HasClient(..)
28+ , clientWithOpts
29+ , clientWithOptsAndResultHandler
30+ , clientWithRoute
31+ , clientWithRouteAndResultHandler
32+ , BuildHeaderKeysTo(..)
33+ , toHeaders
34+ , HasClient
35+ , Client
2236 , module Servant.Common.Req
2337 , module Servant.Common.BaseUrl
2438 ) where
2539
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
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+
4693
4794-- * Accessing APIs as a Client
4895
@@ -54,116 +101,191 @@ import Reflex.Dom.Xhr
54101-- > myApi :: Proxy MyApi
55102-- > myApi = Proxy
56103-- >
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)))
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)))
60107-- > (getAllBooks :<|> postNewBook) = client myApi host
61108-- > where host = constDyn $ BaseUrl Http "localhost" 8080
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
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+
65142
66143-- | This class lets us define how each API combinator
67144-- influences the creation of an HTTP request. It's mostly
68145-- an internal class, you can just use 'client'.
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
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
72175
73176
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−
80177-- Capture. Example:
81178-- > type MyApi = "books" :> Capture "isbn" Text :> Get '[JSON] Book
82179-- >
83180-- > myApi :: Proxy MyApi = Proxy
84181-- >
85−-- > getBook :: MonadWidget t m
182+-- > getBook :: SupportsServantReflex t m
86183-- => Dynamic t BaseUrl
87−-- -> Behavior t (Maybe Text)
88−-- -> Event t ()
89−-- -> m (Event t (Either XhrError (Text, Book)))
184+-- -> Dynamic t (Maybe Text)
185+-- -> Event t l
186+-- -> m (Event t (l, ReqResult Book))
90187-- > 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
93188
94− type Client t m (Capture capture a :> sublayout) =
95− Behavior t (Either String a) -> Client t m sublayout
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
96194
97− clientWithRoute Proxy q req baseurl val =
98− clientWithRoute (Proxy :: Proxy sublayout)
99− q
100− (prependToPathParts p req)
101− baseurl
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
102199
103− where p = (fmap . fmap) (unpack . toUrlPiece) val
104200
105201-- VERB (Returning content) --
106202instance {-# OVERLAPPABLE #-}
107203 -- Note [Non-Empty Content Types]
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))
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))
112208 -- TODO how to access input types here?
113209 -- ExceptT ServantError IO a
114− clientWithRoute Proxy q req baseurl =
115− performRequestCT (Proxy :: Proxy ct) method req' baseurl
116− where method = BS.unpack $ reflectMethod (Proxy :: Proxy method)
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)
117213 req' = req { reqMethod = method }
118214
215+
119216-- -- VERB (No content) --
120217instance {-# OVERLAPPING #-}
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))
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))
125222 -- TODO: how to access input types here?
126223 -- ExceptT ServantError IO NoContent
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−-- }
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}
151236
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
152256-- TODO Overlapping??
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−-- }
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+
167289
168290
169291-- HEADER
@@ -180,34 +302,45 @@ instance {-# OVERLAPPING #-}
180302-- > -- then you can just use "viewRefer" to query that endpoint
181303-- > -- specifying Nothing or e.g Just "http://haskell.org/" as arguments
182304instance (KnownSymbol sym, ToHttpApiData a,
183− HasClient t m sublayout, MonadWidget t m)
184− => HasClient t m (Header sym a :> sublayout) where
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)
185317
186− type Client t m (Header sym a :> sublayout) =
187− Behavior t (Either String a) -> Client t m sublayout
188318
189− clientWithRoute Proxy q req baseurl mval =
190− clientWithRoute (Proxy :: Proxy sublayout)
191− q
192− 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
198319
199− where hname = symbolVal (Proxy :: Proxy sym)
200320
201321-- | Using a 'HttpVersion' combinator in your API doesn't affect the client
202322-- functions.
203−instance HasClient t m sublayout
204− => HasClient t m (HttpVersion :> sublayout) where
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)
205342
206− type Client t m (HttpVersion :> sublayout) =
207− Client t m sublayout
208343
209− clientWithRoute Proxy q =
210− clientWithRoute (Proxy :: Proxy sublayout) q
211344
212345
213346-- | If you use a 'QueryParam' in one of your endpoints in your API,
@@ -236,21 +369,24 @@ instance HasClient t m sublayout
236369-- > -- then you can just use "getBooksBy" to query that endpoint.
237370-- > -- 'getBooksBy Nothing' for all books
238371-- > -- 'getBooksBy (Just "Isaac Asimov")' to get all books by Isaac Asimov
239−instance (KnownSymbol sym, ToHttpApiData a, HasClient t m sublayout, Reflex t)
240− => HasClient t m (QueryParam sym a :> sublayout) where
372+instance (KnownSymbol sym, ToHttpApiData a, HasClient t m sublayout tag, Reflex t)
373+ => HasClient t m (QueryParam sym a :> sublayout) tag where
241374
242− type Client t m (QueryParam sym a :> sublayout) =
243− -- TODO (Maybe a), or (Maybe (Maybe a))? (should the user be able to send a Nothing)
244− Behavior t (QParam a) -> Client t m sublayout
375+ type Client t m (QueryParam sym a :> sublayout) tag =
376+ Dynamic t (QParam a) -> Client t m sublayout tag
245377
246378 -- if mparam = Nothing, we don't add it to the query string
247− clientWithRoute Proxy q req baseurl mparam =
248− clientWithRoute (Proxy :: Proxy sublayout) q
249− (req {qParams = paramPair : qParams req}) baseurl
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
250382
251383 where pname = symbolVal (Proxy :: Proxy sym)
252− p prm = QueryPartParam $ fmap (qParamToQueryPart) prm -- (fmap . fmap) (unpack . toQueryParam) prm
253− paramPair = (pname, p mparam)
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+
254390
255391-- | If you use a 'QueryParams' in one of your endpoints in your API,
256392-- the corresponding querying function will automatically take
@@ -280,21 +416,22 @@ instance (KnownSymbol sym, ToHttpApiData a, HasClient t m sublayout, Reflex t)
280416-- > -- 'getBooksBy []' for all books
281417-- > -- 'getBooksBy ["Isaac Asimov", "Robert A. Heinlein"]'
282418-- > -- to get all books by Asimov and Heinlein
283−instance (KnownSymbol sym, ToHttpApiData a, HasClient t m sublayout, Reflex t)
284− => HasClient t m (QueryParams sym a :> sublayout) where
419+instance (KnownSymbol sym, ToHttpApiData a, HasClient t m sublayout tag, Reflex t)
420+ => HasClient t m (QueryParams sym a :> sublayout) tag where
285421
286− type Client t m (QueryParams sym a :> sublayout) =
287− Behavior t [a] -> Client t m sublayout
422+ type Client t m (QueryParams sym a :> sublayout) tag =
423+ Dynamic t [a] -> Client t m sublayout tag
288424
289− clientWithRoute Proxy q req baseurl paramlist =
290− clientWithRoute (Proxy :: Proxy sublayout) q req' baseurl
425+ clientWithRouteAndResultHandler Proxy q t req baseurl opts wrap paramlist =
426+ clientWithRouteAndResultHandler (Proxy :: Proxy sublayout) q t req' baseurl opts wrap
291427
292− where req' = req { qParams = (pname, params') : qParams req }
428+ where req' = req { qParams = (T.pack pname, params') : qParams req }
293429 pname = symbolVal (Proxy :: Proxy sym)
294− params' = QueryPartParams $ (fmap . fmap) (unpack . toQueryParam)
430+ params' = QueryPartParams $ (fmap . fmap) toQueryParam
295431 paramlist
296432
297433
434+
298435-- | If you use a 'QueryFlag' in one of your endpoints in your API,
299436-- the corresponding querying function will automatically take
300437-- an additional 'Bool' argument.
@@ -319,49 +456,42 @@ instance (KnownSymbol sym, ToHttpApiData a, HasClient t m sublayout, Reflex t)
319456-- > -- 'getBooksBy True' to only get _already published_ books
320457
321458-- TODO Bring back
322−instance (KnownSymbol sym, HasClient t m sublayout, Reflex t)
323− => 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
324461
325− type Client t m (QueryFlag sym :> sublayout) =
326− Behavior t Bool -> Client t m sublayout
462+ type Client t m (QueryFlag sym :> sublayout) tag =
463+ Dynamic t Bool -> Client t m sublayout tag
327464
328− clientWithRoute Proxy q req baseurl flag =
329− clientWithRoute (Proxy :: Proxy sublayout) q req' baseurl
465+ clientWithRouteAndResultHandler Proxy q t req baseurl opts wrap flag =
466+ clientWithRouteAndResultHandler (Proxy :: Proxy sublayout) q t req' baseurl opts wrap
330467
331468 where req' = req { qParams = thisPair : qParams req }
332− thisPair = (pName, QueryPartFlag flag) :: (String, QueryPart t)
469+ thisPair = (T.pack pName, QueryPartFlag flag) :: (Text, QueryPart t)
333470 pName = symbolVal (Proxy :: Proxy sym)
334471
335472
336−-- | Pick a 'Method' and specify where the server you want to query is. You get
337−-- back the full `Response`.
338−-- TODO redo
339−instance (MonadWidget t m) => HasClient t m Raw where
340− type Client t m Raw = Behavior t (Either String XhrRequest)
341− -> Event t ()
342− -> m (Event t (ReqResult ()))
343−
344− -- clientWithRoute :: Proxy Raw -> Proxy m -> Req -> BaseUrl -> Client t m Raw
345− clientWithRoute p q req baseurl xhrs triggers = do
346− let xhrs' = liftA2 (\x path -> case x of
347− Left e -> Left e
348− Right jx -> Right $ jx {_xhrRequest_url = path
349− ++ _xhrRequest_url jx})
350− xhrs
351− (showBaseUrl <$> current baseurl)
352− reqs = tag xhrs' triggers
353− okReq = fmapMaybe hush reqs
354− badReq = fmapMaybe tattle reqs
355− resps <- performRequestAsync okReq
356− return $ leftmost [fmap (ResponseSuccess () ) resps
357− ,fmap RequestFailure badReq]
358−
359−
360−hush :: Either e a -> Maybe a
361−hush = either (const Nothing) Just
362−
363−tattle :: Either e a -> Maybe e
364−tattle = either Just (const Nothing)
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+
365495
366496-- | If you use a 'ReqBody' in one of your endpoints in your API,
367497-- the corresponding querying function will automatically take
@@ -383,59 +513,64 @@ tattle = either Just (const Nothing)
383513-- > where host = BaseUrl Http "localhost" 8080
384514-- > -- then you can just use "addBook" to query that endpoint
385515
386−instance (MimeRender ct a, HasClient t m sublayout, Reflex t)
387− => 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
388518
389− type Client t m (ReqBody (ct ': cts) a :> sublayout) =
390− Behavior t (Either String a) -> Client t m sublayout
519+ type Client t m (ReqBody (ct ': cts) a :> sublayout) tag =
520+ Dynamic t (Either Text a) -> Client t m sublayout tag
391521
392− clientWithRoute Proxy q req baseurl body =
393− clientWithRoute (Proxy :: Proxy sublayout) q req' baseurl
522+ clientWithRouteAndResultHandler Proxy q t req baseurl opts wrap body =
523+ clientWithRouteAndResultHandler (Proxy :: Proxy sublayout) q t req' baseurl opts wrap
394524 where req' = req { reqBody = bodyBytesCT }
395525 ctProxy = Proxy :: Proxy ct
396− ctString = show $ contentType ctProxy
397− --ctString = BS.unpack . CI.original . M.mainType $ contentType ctProxy
526+ ctString = T.pack $ show $ contentType ctProxy
398527 bodyBytesCT = Just $ (fmap . fmap)
399528 (\b -> (mimeRender ctProxy b, ctString))
400529 body
401530
531+
532+
402533-- | Make the querying function append @path@ to the request path.
403−instance (KnownSymbol path, HasClient t m sublayout, Reflex t) => HasClient t m (path :> sublayout) where
404− type Client t m (path :> sublayout) = Client t m sublayout
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
405536
406− clientWithRoute Proxy q req baseurl =
407− clientWithRoute (Proxy :: Proxy sublayout) q
408− (prependToPathParts (constant (Right p)) req)
409− baseurl
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
410540
411541 where p = symbolVal (Proxy :: Proxy path)
412542
413−instance HasClient t m api => HasClient t m (Vault :> api) where
414− type Client t m (Vault :> api) = Client t m api
415543
416− clientWithRoute Proxy q req baseurl =
417− clientWithRoute (Proxy :: Proxy api) q req baseurl
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
418553
419−instance HasClient t m api => HasClient t m (RemoteHost :> api) where
420− type Client t m (RemoteHost :> api) = Client t m api
554+ clientWithRouteAndResultHandler Proxy =
555+ clientWithRouteAndResultHandler (Proxy :: Proxy api)
421556
422− clientWithRoute Proxy q req baseurl =
423− clientWithRoute (Proxy :: Proxy api) q req baseurl
424557
425−instance HasClient t m api => HasClient t m (IsSecure :> api) where
426− type Client t m (IsSecure :> api) = Client t m api
427558
428− clientWithRoute Proxy q req baseurl =
429− clientWithRoute (Proxy :: Proxy api) q req baseurl
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
430561
431−instance (HasClient t m api, Reflex t)
432− => HasClient t m (BasicAuth realm usr :> api) where
562+ clientWithRouteAndResultHandler Proxy =
563+ clientWithRouteAndResultHandler (Proxy :: Proxy api)
433564
434− type Client t m (BasicAuth realm usr :> api) = Behavior t (Maybe BasicAuthData)
435− -> Client t m api
436565
437− clientWithRoute Proxy q req baseurl authdata =
438− clientWithRoute (Proxy :: Proxy api) q req' baseurl
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
439574 where
440575 req' = req { authData = Just authdata }
441576
@@ -461,3 +596,30 @@ non-empty lists, but is otherwise more specific, no instance will be overall
461596more specific. This in turn generally means adding yet another instance (one
462597for empty and one for non-empty lists).
463598-}
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+