@@ -1,576 +1,625 @@
1−{-# LANGUAGE CPP #-}
2−{-# LANGUAGE DataKinds #-}
3−{-# LANGUAGE FlexibleContexts #-}
4−{-# LANGUAGE FlexibleInstances #-}
5−{-# LANGUAGE InstanceSigs #-}
6−{-# LANGUAGE OverloadedStrings #-}
7−{-# LANGUAGE ScopedTypeVariables #-}
8−{-# LANGUAGE TypeFamilies #-}
9−{-# LANGUAGE TypeOperators #-}
10−{-# LANGUAGE UndecidableInstances #-}
11−#if !MIN_VERSION_base(4,8,0)
12−{-# LANGUAGE OverlappingInstances #-}
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 #-}
1320#endif
21+
22+-- #include "overlapping-compat.h"
1423-- | This module provides 'client' which can automatically generate
1524-- querying functions for each endpoint just from the type representing your
1625-- API.
1726module Servant.Reflex
1827 ( client
19− , HasReflexClient(..)
20− , ServantError(..)
28+ , clientWithOpts
29+ , clientWithOptsAndResultHandler
30+ , clientWithRoute
31+ , clientWithRouteAndResultHandler
32+ , BuildHeaderKeysTo(..)
33+ , toHeaders
34+ , HasClient
35+ , Client
36+ , module Servant.Common.Req
2137 , module Servant.Common.BaseUrl
2238 ) where
2339
24−#if !MIN_VERSION_base(4,8,0)
25−import Control.Applicative ((<$>))
26−#endif
27−import Control.Monad
28−import Control.Monad.Trans.Except
29−import Data.ByteString.Lazy (ByteString)
30−import Data.List
31−import Data.Proxy
32−import Data.String.Conversions
33−import Data.Text (unpack)
34−import GHC.TypeLits
35−import Network.HTTP.Media
36−import qualified Network.HTTP.Types as H
37−import qualified Network.HTTP.Types.Header as HTTP
38−import Servant.API
39−import Servant.Common.BaseUrl
40−import Servant.Common.Req
41−import Web.HttpApiData
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+
4293
4394-- * Accessing APIs as a Client
4495
4596-- | 'client' allows you to produce operations to query an API from a client.
4697--
4798-- > type MyApi = "books" :> Get '[JSON] [Book] -- GET /books
48−-- > :<|> "books" :> ReqBody '[JSON] Book :> Post Book -- POST /books
99+-- > :<|> "books" :> ReqBody '[JSON] Book :> Post '[JSON] Book -- POST /books
49100-- >
50101-- > myApi :: Proxy MyApi
51102-- > myApi = Proxy
52103-- >
53−-- > getAllBooks :: ExceptT String IO [Book]
54−-- > postNewBook :: Book -> ExceptT String IO 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)))
55107-- > (getAllBooks :<|> postNewBook) = client myApi host
56−-- > where host = BaseUrl Http "localhost" 8080
57−client :: HasReflexClient layout => Proxy layout -> BaseUrl -> Input layout -> Client layout
58−client p baseurl = clientWithRoute p defReq baseurl
108+-- > where host = constDyn $ BaseUrl Http "localhost" 8080
109+client
110+ :: (HasClient t m layout tag)
111+ => Proxy layout
112+ -> Proxy m
113+ -> Proxy tag
114+ -> Dynamic t BaseUrl
115+ -> Client t m layout tag
116+client p q t baseurl = clientWithRoute p q t defReq baseurl defaultClientOptions
59117
60−type Final a = forall m. m a
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
61127
62−data a ::> b = a ::> b deriving (Eq,Ord,Show,Read)
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
63141
64−infixr 3 ::>
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 HasReflexClient layout where
70− type Input layout :: *
71− type Client layout :: *
72− clientWithRoute :: Proxy layout -> Req -> BaseUrl -> Input layout -> Client layout
73−
74−
75−-- | If you have a 'Get' endpoint in your API, the client
76−-- side querying function that is created when calling 'client'
77−-- will just require an argument that specifies the scheme, host
78−-- and port to send the request to.
79−instance
80−#if MIN_VERSION_base(4,8,0)
81− {-# OVERLAPPABLE #-}
82−#endif
83− (MimeUnrender ct result) => HasReflexClient (Get (ct ': cts) result) where
84− type Input (Get (ct ': cts) result) = ()
85− type Client (Get (ct ': cts) result) = Final result
86− clientWithRoute Proxy req baseurl _ =
87− snd <$> performRequestCT (Proxy :: Proxy ct) H.methodGet req baseurl
88−
89−instance
90−#if MIN_VERSION_base(4,8,0)
91− {-# OVERLAPPING #-}
92−#endif
93− HasReflexClient (Get (ct ': cts) ()) where
94− type Input (Get (ct ': cts) ()) = ()
95− type Client (Get (ct ': cts) ()) = Final ()
96− clientWithRoute Proxy req baseurl _ =
97− performRequestNoBody H.methodGet req baseurl
98−
99−-- | Pick a 'Method' and specify where the server you want to query is. You get
100−-- back the full `Response`.
101−instance HasReflexClient Raw where
102− type Input Raw = H.Method ::> ()
103− type Client Raw = Final (Int, ByteString, MediaType, [HTTP.Header], Response ByteString)
104−
105− clientWithRoute :: Proxy Raw -> Req -> BaseUrl -> Input Raw -> Client Raw
106− clientWithRoute Proxy req baseurl (httpMethod ::> ()) = do
107− performRequest httpMethod req baseurl
108−
109−-- -- | If you have a 'Get xs (Headers ls x)' endpoint, the client expects the
110−-- -- corresponding headers.
111−-- instance
112−-- #if MIN_VERSION_base(4,8,0)
113−-- {-# OVERLAPPING #-}
114−-- #endif
115−-- ( MimeUnrender ct a, BuildHeadersTo ls
116−-- ) => HasReflexClient (Get (ct ': cts) (Headers ls a)) where
117−-- type Input (Get (ct ': cts) (Headers ls a)) = ()
118−-- type Client (Get (ct ': cts) (Headers ls a)) = Final (Headers ls a)
119−-- clientWithRoute Proxy req baseurl _ = do
120−-- (hdrs, resp) <- performRequestCT (Proxy :: Proxy ct) H.methodGet req baseurl
121−-- return $ Headers { getResponse = resp
122−-- , getHeadersHList = buildHeadersTo hdrs
123−-- }
124−--
125−-- -- | A client querying function for @a ':<|>' b@ will actually hand you
126−-- -- one function for querying @a@ and another one for querying @b@,
127−-- -- stitching them together with ':<|>', which really is just like a pair.
128−-- --
129−-- -- > type MyApi = "books" :> Get '[JSON] [Book] -- GET /books
130−-- -- > :<|> "books" :> ReqBody '[JSON] Book :> Post Book -- POST /books
131−-- -- >
132−-- -- > myApi :: Proxy MyApi
133−-- -- > myApi = Proxy
134−-- -- >
135−-- -- > getAllBooks :: ExceptT String IO [Book]
136−-- -- > postNewBook :: Book -> ExceptT String IO Book
137−-- -- > (getAllBooks :<|> postNewBook) = client myApi host
138−-- -- > where host = BaseUrl Http "localhost" 8080
139−-- instance (HasReflexClient a, HasReflexClient b) => HasReflexClient (a :<|> b) where
140−-- type Input (a :<|> b) = Input a :<|> Input b
141−-- type Client (a :<|> b) = Client a :<|> Client b
142−-- clientWithRoute Proxy req baseurl (a :<|> b) =
143−-- clientWithRoute (Proxy :: Proxy a) req baseurl a :<|>
144−-- clientWithRoute (Proxy :: Proxy b) req baseurl b
145−--
146−-- ------------------------------------------------------------------------------
147−-- -- | If you use a 'Capture' in one of your endpoints in your API,
148−-- -- the corresponding querying function will automatically take
149−-- -- an additional argument of the type specified by your 'Capture'.
150−-- -- That function will take care of inserting a textual representation
151−-- -- of this value at the right place in the request path.
152−-- --
153−-- -- You can control how values for this type are turned into
154−-- -- text by specifying a 'ToHttpApiData' instance for your type.
155−-- --
156−-- -- Example:
157−-- --
158−-- -- > type MyApi = "books" :> Capture "isbn" Text :> Get '[JSON] Book
159−-- -- >
160−-- -- > myApi :: Proxy MyApi
161−-- -- > myApi = Proxy
162−-- -- >
163−-- -- > getBook :: Text -> ExceptT String IO Book
164−-- -- > getBook = client myApi host
165−-- -- > where host = BaseUrl Http "localhost" 8080
166−-- -- > -- then you can just use "getBook" to query that endpoint
167−-- instance (KnownSymbol capture, ToHttpApiData a, HasReflexClient sublayout)
168−-- => HasReflexClient (Capture capture a :> sublayout) where
169−--
170−-- type Input (Capture cap a :> sublayout) = a ::> Input sublayout
171−-- type Client (Capture capture a :> sublayout) = Client sublayout
172−--
173−-- clientWithRoute Proxy req baseurl (val ::> rest) =
174−-- clientWithRoute (Proxy :: Proxy sublayout)
175−-- (appendToPath p req) baseurl rest
176−--
177−-- where p = unpack (toUrlPiece val)
178−--
179−-- -- | If you have a 'Delete' endpoint in your API, the client
180−-- -- side querying function that is created when calling 'client'
181−-- -- will just require an argument that specifies the scheme, host
182−-- -- and port to send the request to.
183−-- instance
184−-- #if MIN_VERSION_base(4,8,0)
185−-- {-# OVERLAPPABLE #-}
186−-- #endif
187−-- (MimeUnrender ct a, cts' ~ (ct ': cts)) => HasReflexClient (Delete cts' a) where
188−-- type Input (Delete cts' a) = ()
189−-- type Client (Delete cts' a) = Final a
190−-- clientWithRoute Proxy req baseurl val =
191−-- snd <$> performRequestCT (Proxy :: Proxy ct) H.methodDelete req baseurl val
192−--
193−-- instance
194−-- #if MIN_VERSION_base(4,8,0)
195−-- {-# OVERLAPPING #-}
196−-- #endif
197−-- HasReflexClient (Delete cts ()) where
198−-- type Input (Delete cts ()) = ()
199−-- type Client (Delete cts ()) = Final ()
200−-- clientWithRoute Proxy req baseurl val =
201−-- void $ performRequestNoBody H.methodDelete req baseurl val
202−--
203−-- -- | If you have a 'Delete xs (Headers ls x)' endpoint, the client expects the
204−-- -- corresponding headers.
205−-- instance
206−-- #if MIN_VERSION_base(4,8,0)
207−-- {-# OVERLAPPING #-}
208−-- #endif
209−-- ( MimeUnrender ct a, BuildHeadersTo ls, cts' ~ (ct ': cts)
210−-- ) => HasReflexClient (Delete cts' (Headers ls a)) where
211−-- type Input (Delete cts' (Headers ls a)) = ()
212−-- type Client (Delete cts' (Headers ls a)) = Final (Headers ls a)
213−-- clientWithRoute Proxy req baseurl _ = do
214−-- (hdrs, resp) <- performRequestCT (Proxy :: Proxy ct) H.methodDelete req baseurl
215−-- return $ Headers { getResponse = resp
216−-- , getHeadersHList = buildHeadersTo hdrs
217−-- }
218−--
219−-- -- | If you use a 'Header' in one of your endpoints in your API,
220−-- -- the corresponding querying function will automatically take
221−-- -- an additional argument of the type specified by your 'Header',
222−-- -- wrapped in Maybe.
223−-- --
224−-- -- That function will take care of encoding this argument as Text
225−-- -- in the request headers.
226−-- --
227−-- -- All you need is for your type to have a 'ToHttpApiData' instance.
228−-- --
229−-- -- Example:
230−-- --
231−-- -- > newtype Referer = Referer { referrer :: Text }
232−-- -- > deriving (Eq, Show, Generic, FromText, ToHttpApiData)
233−-- -- >
234−-- -- > -- GET /view-my-referer
235−-- -- > type MyApi = "view-my-referer" :> Header "Referer" Referer :> Get '[JSON] Referer
236−-- -- >
237−-- -- > myApi :: Proxy MyApi
238−-- -- > myApi = Proxy
239−-- -- >
240−-- -- > viewReferer :: Maybe Referer -> ExceptT String IO Book
241−-- -- > viewReferer = client myApi host
242−-- -- > where host = BaseUrl Http "localhost" 8080
243−-- -- > -- then you can just use "viewRefer" to query that endpoint
244−-- -- > -- specifying Nothing or e.g Just "http://haskell.org/" as arguments
245−-- instance (KnownSymbol sym, ToHttpApiData a, HasReflexClient sublayout)
246−-- => HasReflexClient (Header sym a :> sublayout) where
247−--
248−-- type Input (Header sym a :> sublayout) = Maybe a ::> Input sublayout
249−-- type Client (Header sym a :> sublayout) = Client sublayout
250−--
251−-- clientWithRoute Proxy req baseurl (mval ::> rest) =
252−-- clientWithRoute (Proxy :: Proxy sublayout)
253−-- (maybe req
254−-- (\value -> Servant.Common.Req.addHeader hname value req)
255−-- mval
256−-- )
257−-- baseurl rest
258−--
259−-- where hname = symbolVal (Proxy :: Proxy sym)
260−--
261−-- -- | If you have a 'Post' endpoint in your API, the client
262−-- -- side querying function that is created when calling 'client'
263−-- -- will just require an argument that specifies the scheme, host
264−-- -- and port to send the request to.
265−-- instance
266−-- #if MIN_VERSION_base(4,8,0)
267−-- {-# OVERLAPPABLE #-}
268−-- #endif
269−-- (MimeUnrender ct a) => HasReflexClient (Post (ct ': cts) a) where
270−-- type Input (Post (ct ': cts) a) = ()
271−-- type Client (Post (ct ': cts) a) = Final a
272−-- clientWithRoute Proxy req baseurl _ =
273−-- snd <$> performRequestCT (Proxy :: Proxy ct) H.methodPost req baseurl
274−--
275−-- instance
276−-- #if MIN_VERSION_base(4,8,0)
277−-- {-# OVERLAPPING #-}
278−-- #endif
279−-- HasReflexClient (Post (ct ': cts) ()) where
280−-- type Input (Post (ct ': cts) ()) = ()
281−-- type Client (Post (ct ': cts) ()) = Final ()
282−-- clientWithRoute Proxy req baseurl _ =
283−-- void $ performRequestNoBody H.methodPost req baseurl
284−--
285−-- -- | If you have a 'Post xs (Headers ls x)' endpoint, the client expects the
286−-- -- corresponding headers.
287−-- instance
288−-- #if MIN_VERSION_base(4,8,0)
289−-- {-# OVERLAPPING #-}
290−-- #endif
291−-- ( MimeUnrender ct a, BuildHeadersTo ls
292−-- ) => HasReflexClient (Post (ct ': cts) (Headers ls a)) where
293−-- type Input (Post (ct ': cts) (Headers ls a)) = ()
294−-- type Client (Post (ct ': cts) (Headers ls a)) = Final (Headers ls a)
295−-- clientWithRoute Proxy req baseurl _ = do
296−-- (hdrs, resp) <- performRequestCT (Proxy :: Proxy ct) H.methodPost req baseurl
297−-- return $ Headers { getResponse = resp
298−-- , getHeadersHList = buildHeadersTo hdrs
299−-- }
300−--
301−-- -- | If you have a 'Put' endpoint in your API, the client
302−-- -- side querying function that is created when calling 'client'
303−-- -- will just require an argument that specifies the scheme, host
304−-- -- and port to send the request to.
305−-- instance
306−-- #if MIN_VERSION_base(4,8,0)
307−-- {-# OVERLAPPABLE #-}
308−-- #endif
309−-- (MimeUnrender ct a) => HasReflexClient (Put (ct ': cts) a) where
310−-- type Input (Put (ct ': cts) a) = ()
311−-- type Client (Put (ct ': cts) a) = Final a
312−-- clientWithRoute Proxy req baseurl _ =
313−-- snd <$> performRequestCT (Proxy :: Proxy ct) H.methodPut req baseurl
314−--
315−-- instance
316−-- #if MIN_VERSION_base(4,8,0)
317−-- {-# OVERLAPPING #-}
318−-- #endif
319−-- HasReflexClient (Put (ct ': cts) ()) where
320−-- type Input (Put (ct ': cts) ()) = ()
321−-- type Client (Put (ct ': cts) ()) = Final ()
322−-- clientWithRoute Proxy req baseurl _ =
323−-- void $ performRequestNoBody H.methodPut req baseurl
324−--
325−-- -- | If you have a 'Put xs (Headers ls x)' endpoint, the client expects the
326−-- -- corresponding headers.
327−-- instance
328−-- #if MIN_VERSION_base(4,8,0)
329−-- {-# OVERLAPPING #-}
330−-- #endif
331−-- ( MimeUnrender ct a, BuildHeadersTo ls
332−-- ) => HasReflexClient (Put (ct ': cts) (Headers ls a)) where
333−-- type Input (Put (ct ': cts) (Headers ls a)) = ()
334−-- type Client (Put (ct ': cts) (Headers ls a)) = Final (Headers ls a)
335−-- clientWithRoute Proxy req baseurl _ = do
336−-- (hdrs, resp) <- performRequestCT (Proxy :: Proxy ct) H.methodPut req baseurl
337−-- return $ Headers { getResponse = resp
338−-- , getHeadersHList = buildHeadersTo hdrs
339−-- }
340−--
341−-- -- | If you have a 'Patch' endpoint in your API, the client
342−-- -- side querying function that is created when calling 'client'
343−-- -- will just require an argument that specifies the scheme, host
344−-- -- and port to send the request to.
345−-- instance
346−-- #if MIN_VERSION_base(4,8,0)
347−-- {-# OVERLAPPABLE #-}
348−-- #endif
349−-- (MimeUnrender ct a) => HasReflexClient (Patch (ct ': cts) a) where
350−-- type Input (Patch (ct ': cts) a) = ()
351−-- type Client (Patch (ct ': cts) a) = Final a
352−-- clientWithRoute Proxy req baseurl _ =
353−-- snd <$> performRequestCT (Proxy :: Proxy ct) H.methodPatch req baseurl
354−--
355−-- instance
356−-- #if MIN_VERSION_base(4,8,0)
357−-- {-# OVERLAPPING #-}
358−-- #endif
359−-- HasReflexClient (Patch (ct ': cts) ()) where
360−-- type Input (Patch (ct ': cts) ()) = ()
361−-- type Client (Patch (ct ': cts) ()) = Final ()
362−-- clientWithRoute Proxy req baseurl _ =
363−-- void $ performRequestNoBody H.methodPatch req baseurl
364−--
365−-- -- | If you have a 'Patch xs (Headers ls x)' endpoint, the client expects the
366−-- -- corresponding headers.
367−-- instance
368−-- #if MIN_VERSION_base(4,8,0)
369−-- {-# OVERLAPPING #-}
370−-- #endif
371−-- ( MimeUnrender ct a, BuildHeadersTo ls
372−-- ) => HasReflexClient (Patch (ct ': cts) (Headers ls a)) where
373−-- type Input (Patch (ct ': cts) (Headers ls a)) = ()
374−-- type Client (Patch (ct ': cts) (Headers ls a)) = Final (Headers ls a)
375−-- clientWithRoute Proxy req baseurl _ = do
376−-- (hdrs, resp) <- performRequestCT (Proxy :: Proxy ct) H.methodPatch req baseurl
377−-- return $ Headers { getResponse = resp
378−-- , getHeadersHList = buildHeadersTo hdrs
379−-- }
380−--
381−-- -- | If you use a 'QueryParam' in one of your endpoints in your API,
382−-- -- the corresponding querying function will automatically take
383−-- -- an additional argument of the type specified by your 'QueryParam',
384−-- -- enclosed in Maybe.
385−-- --
386−-- -- If you give Nothing, nothing will be added to the query string.
387−-- --
388−-- -- If you give a non-'Nothing' value, this function will take care
389−-- -- of inserting a textual representation of this value in the query string.
390−-- --
391−-- -- You can control how values for your type are turned into
392−-- -- text by specifying a 'ToHttpApiData' instance for your type.
393−-- --
394−-- -- Example:
395−-- --
396−-- -- > type MyApi = "books" :> QueryParam "author" Text :> Get '[JSON] [Book]
397−-- -- >
398−-- -- > myApi :: Proxy MyApi
399−-- -- > myApi = Proxy
400−-- -- >
401−-- -- > getBooksBy :: Maybe Text -> ExceptT String IO [Book]
402−-- -- > getBooksBy = client myApi host
403−-- -- > where host = BaseUrl Http "localhost" 8080
404−-- -- > -- then you can just use "getBooksBy" to query that endpoint.
405−-- -- > -- 'getBooksBy Nothing' for all books
406−-- -- > -- 'getBooksBy (Just "Isaac Asimov")' to get all books by Isaac Asimov
407−-- instance (KnownSymbol sym, ToHttpApiData a, HasReflexClient sublayout)
408−-- => HasReflexClient (QueryParam sym a :> sublayout) where
409−--
410−-- type Input (QueryParam sym a :> sublayout) = Maybe a ::> Input sublayout
411−-- type Client (QueryParam sym a :> sublayout) = Client sublayout
412−--
413−-- -- if mparam = Nothing, we don't add it to the query string
414−-- clientWithRoute Proxy req baseurl (mparam ::> rest) =
415−-- clientWithRoute (Proxy :: Proxy sublayout)
416−-- (maybe req
417−-- (flip (appendToQueryString pname) req . Just)
418−-- mparamText
419−-- )
420−-- baseurl rest
421−--
422−-- where pname = cs pname'
423−-- pname' = symbolVal (Proxy :: Proxy sym)
424−-- mparamText = fmap toQueryParam mparam
425−--
426−-- -- | If you use a 'QueryParams' in one of your endpoints in your API,
427−-- -- the corresponding querying function will automatically take
428−-- -- an additional argument, a list of values of the type specified
429−-- -- by your 'QueryParams'.
430−-- --
431−-- -- If you give an empty list, nothing will be added to the query string.
432−-- --
433−-- -- Otherwise, this function will take care
434−-- -- of inserting a textual representation of your values in the query string,
435−-- -- under the same query string parameter name.
436−-- --
437−-- -- You can control how values for your type are turned into
438−-- -- text by specifying a 'ToHttpApiData' instance for your type.
439−-- --
440−-- -- Example:
441−-- --
442−-- -- > type MyApi = "books" :> QueryParams "authors" Text :> Get '[JSON] [Book]
443−-- -- >
444−-- -- > myApi :: Proxy MyApi
445−-- -- > myApi = Proxy
446−-- -- >
447−-- -- > getBooksBy :: [Text] -> ExceptT String IO [Book]
448−-- -- > getBooksBy = client myApi host
449−-- -- > where host = BaseUrl Http "localhost" 8080
450−-- -- > -- then you can just use "getBooksBy" to query that endpoint.
451−-- -- > -- 'getBooksBy []' for all books
452−-- -- > -- 'getBooksBy ["Isaac Asimov", "Robert A. Heinlein"]'
453−-- -- > -- to get all books by Asimov and Heinlein
454−-- instance (KnownSymbol sym, ToHttpApiData a, HasReflexClient sublayout)
455−-- => HasReflexClient (QueryParams sym a :> sublayout) where
456−--
457−-- type Input (QueryParams sym a :> sublayout) = [a] ::> Input sublayout
458−-- type Client (QueryParams sym a :> sublayout) = Client sublayout
459−--
460−-- clientWithRoute Proxy req baseurl (paramlist ::> rest) =
461−-- clientWithRoute (Proxy :: Proxy sublayout)
462−-- (foldl' (\ req' -> maybe req' (flip (appendToQueryString pname) req' . Just))
463−-- req
464−-- paramlist'
465−-- )
466−-- baseurl rest
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
175+
176+
177+-- Capture. Example:
178+-- > type MyApi = "books" :> Capture "isbn" Text :> Get '[JSON] Book
179+-- >
180+-- > myApi :: Proxy MyApi = Proxy
181+-- >
182+-- > getBook :: SupportsServantReflex t m
183+-- => Dynamic t BaseUrl
184+-- -> Dynamic t (Maybe Text)
185+-- -> Event t l
186+-- -> m (Event t (l, ReqResult Book))
187+-- > getBook = client myApi (constDyn host)
188+
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
194+
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
199+
200+
201+-- VERB (Returning content) --
202+instance {-# OVERLAPPABLE #-}
203+ -- Note [Non-Empty Content Types]
204+ (MimeUnrender ct a, ReflectMethod method, cts' ~ (ct ': cts), SupportsServantReflex t m
205+ ) => HasClient t m (Verb method status cts' a) tag where
206+ type Client t m (Verb method status cts' a) tag =
207+ Event t tag -> m (Event t (ReqResult tag a))
208+ -- TODO how to access input types here?
209+ -- ExceptT ServantError IO a
210+ clientWithRouteAndResultHandler Proxy _ _ req baseurl opts wrap trigs =
211+ wrap =<< fmap runIdentity <$> performRequestsCT (Proxy :: Proxy ct) method (constDyn $ Identity $ req') baseurl opts trigs
212+ where method = E.decodeUtf8 $ reflectMethod (Proxy :: Proxy method)
213+ req' = req { reqMethod = method }
214+
215+
216+-- -- VERB (No content) --
217+instance {-# OVERLAPPING #-}
218+ (ReflectMethod method, SupportsServantReflex t m) =>
219+ HasClient t m (Verb method status cts NoContent) tag where
220+ type Client t m (Verb method status cts NoContent) tag =
221+ Event t tag -> m (Event t (ReqResult tag NoContent))
222+ -- TODO: how to access input types here?
223+ -- ExceptT ServantError IO NoContent
224+ clientWithRouteAndResultHandler Proxy _ _ req baseurl opts wrap trigs =
225+ wrap =<< fmap runIdentity <$> performRequestsNoBody method (constDyn $ Identity req) baseurl opts trigs
226+ where method = E.decodeUtf8 $ reflectMethod (Proxy :: Proxy method)
227+
228+
229+toHeaders :: BuildHeadersTo ls => ReqResult tag a -> ReqResult tag (Headers ls a)
230+toHeaders r =
231+ let hdrs = maybe []
232+ (\xhr -> fmap (\(h,v) -> (CI.map E.encodeUtf8 h, E.encodeUtf8 v))
233+ (Map.toList $ _xhrResponse_headers xhr))
234+ (response r)
235+ in ffor r $ \a -> Headers {getResponse = a ,getHeadersHList = buildHeadersTo hdrs}
236+
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
256+-- TODO Overlapping??
257+instance {-# OVERLAPPABLE #-}
258+ -- Note [Non-Empty Content Types]
259+ ( MimeUnrender ct a, BuildHeadersTo ls, BuildHeaderKeysTo ls,
260+ ReflectMethod method, cts' ~ (ct ': cts),
261+ SupportsServantReflex t m
262+ ) => HasClient t m (Verb method status cts' (Headers ls a)) tag where
263+ type Client t m (Verb method status cts' (Headers ls a)) tag =
264+ Event t tag -> m (Event t (ReqResult tag (Headers ls a)))
265+ clientWithRouteAndResultHandler Proxy _ _ req baseurl opts wrap trigs = do
266+ let method = E.decodeUtf8 $ reflectMethod (Proxy :: Proxy method)
267+ resp <- fmap runIdentity <$> performRequestsCT (Proxy :: Proxy ct) method (constDyn $ Identity req') baseurl opts trigs
268+ wrap $ toHeaders <$> resp
269+ where req' = req { respHeaders =
270+ OnlyHeaders (Set.fromList (buildHeaderKeysTo (Proxy :: Proxy ls)))
271+ }
272+
273+
274+-- HEADERS Verb (No content) --
275+instance {-# OVERLAPPABLE #-}
276+ ( BuildHeadersTo ls, BuildHeaderKeysTo ls, ReflectMethod method,
277+ SupportsServantReflex t m
278+ ) => HasClient t m (Verb method status cts (Headers ls NoContent)) tag where
279+ type Client t m (Verb method status cts (Headers ls NoContent)) tag
280+ = Event t tag -> m (Event t (ReqResult tag (Headers ls NoContent)))
281+ clientWithRouteAndResultHandler Proxy _ _ req baseurl opts wrap trigs = do
282+ let method = E.decodeUtf8 $ reflectMethod (Proxy :: Proxy method)
283+ resp <- fmap runIdentity <$> performRequestsNoBody method (constDyn $ Identity req') baseurl opts trigs
284+ wrap $ toHeaders <$> resp
285+ where req' = req {respHeaders =
286+ OnlyHeaders (Set.fromList (buildHeaderKeysTo (Proxy :: Proxy ls)))
287+ }
288+
289+
290+
291+-- HEADER
292+-- > newtype Referer = Referer { referrer :: Text }
293+-- > deriving (Eq, Show, Generic, FromText, ToHttpApiData)
294+-- >
295+-- > -- GET /view-my-referer
296+-- > type MyApi = "view-my-referer" :> Header "Referer" Referer :> Get '[JSON] Referer
297+-- >
298+-- >
299+-- > viewReferer :: Maybe Referer -> ExceptT String IO Book
300+-- > viewReferer = client myApi host
301+-- > where host = BaseUrl Http "localhost" 8080
302+-- > -- then you can just use "viewRefer" to query that endpoint
303+-- > -- specifying Nothing or e.g Just "http://haskell.org/" as arguments
304+instance (KnownSymbol sym, ToHttpApiData a,
305+ HasClient t m sublayout tag, SupportsServantReflex t m)
306+ => HasClient t m (Header sym a :> sublayout) tag where
307+
308+ type Client t m (Header sym a :> sublayout) tag =
309+ Dynamic t (Either Text a) -> Client t m sublayout tag
310+
311+ clientWithRouteAndResultHandler Proxy q t req baseurl opts wrap eVal =
312+ clientWithRouteAndResultHandler
313+ (Proxy :: Proxy sublayout) q t
314+ (Servant.Common.Req.addHeader hname eVal req)
315+ baseurl opts wrap
316+ where hname = T.pack $ symbolVal (Proxy :: Proxy sym)
317+
318+
319+
320+
321+-- | Using a 'HttpVersion' combinator in your API doesn't affect the client
322+-- functions.
323+instance HasClient t m sublayout tag
324+ => HasClient t m (HttpVersion :> sublayout) tag where
325+
326+ type Client t m (HttpVersion :> sublayout) tag =
327+ Client t m sublayout tag
328+
329+ clientWithRouteAndResultHandler Proxy =
330+ clientWithRouteAndResultHandler (Proxy :: Proxy sublayout)
331+
332+-- | Using a 'Summary' combinator in your API doesn't affect the client
333+-- functions.
334+instance (HasClient t m sublayout tag, KnownSymbol sym)
335+ => HasClient t m (Summary sym :> sublayout) tag where
336+
337+ type Client t m (Summary sym :> sublayout) tag =
338+ Client t m sublayout tag
339+
340+ clientWithRouteAndResultHandler Proxy =
341+ clientWithRouteAndResultHandler (Proxy :: Proxy sublayout)
342+
343+
344+
345+
346+-- | If you use a 'QueryParam' in one of your endpoints in your API,
347+-- the corresponding querying function will automatically take
348+-- an additional argument of the type specified by your 'QueryParam',
349+-- enclosed in Maybe.
467350--
468−-- where pname = cs pname'
469−-- pname' = symbolVal (Proxy :: Proxy sym)
470−-- paramlist' = map (Just . toQueryParam) paramlist
351+-- If you give Nothing, nothing will be added to the query string.
471352--
472−-- -- | If you use a 'QueryFlag' in one of your endpoints in your API,
473−-- -- the corresponding querying function will automatically take
474−-- -- an additional 'Bool' argument.
475−-- --
476−-- -- If you give 'False', nothing will be added to the query string.
477−-- --
478−-- -- Otherwise, this function will insert a value-less query string
479−-- -- parameter under the name associated to your 'QueryFlag'.
480−-- --
481−-- -- Example:
482−-- --
483−-- -- > type MyApi = "books" :> QueryFlag "published" :> Get '[JSON] [Book]
484−-- -- >
485−-- -- > myApi :: Proxy MyApi
486−-- -- > myApi = Proxy
487−-- -- >
488−-- -- > getBooks :: Bool -> ExceptT String IO [Book]
489−-- -- > getBooks = client myApi host
490−-- -- > where host = BaseUrl Http "localhost" 8080
491−-- -- > -- then you can just use "getBooks" to query that endpoint.
492−-- -- > -- 'getBooksBy False' for all books
493−-- -- > -- 'getBooksBy True' to only get _already published_ books
494−-- instance (KnownSymbol sym, HasReflexClient sublayout)
495−-- => HasReflexClient (QueryFlag sym :> sublayout) where
353+-- If you give a non-'Nothing' value, this function will take care
354+-- of inserting a textual representation of this value in the query string.
496355--
497−-- type Input (QueryFlag sym :> sublayout) = Bool ::> Input sublayout
498−-- type Client (QueryFlag sym :> sublayout) = Client sublayout
356+-- You can control how values for your type are turned into
357+-- text by specifying a 'ToHttpApiData' instance for your type.
499358--
500−-- clientWithRoute Proxy req baseurl (flag ::> rest) =
501−-- clientWithRoute (Proxy :: Proxy sublayout)
502−-- (if flag
503−-- then appendToQueryString paramname Nothing req
504−-- else req
505−-- )
506−-- baseurl rest
359+-- Example:
507360--
508−-- where paramname = cs $ symbolVal (Proxy :: Proxy sym)
361+-- > type MyApi = "books" :> QueryParam "author" Text :> Get '[JSON] [Book]
362+-- >
363+-- > myApi :: Proxy MyApi
364+-- > myApi = Proxy
365+-- >
366+-- > getBooksBy :: Maybe Text -> ExceptT String IO [Book]
367+-- > getBooksBy = client myApi host
368+-- > where host = BaseUrl Http "localhost" 8080
369+-- > -- then you can just use "getBooksBy" to query that endpoint.
370+-- > -- 'getBooksBy Nothing' for all books
371+-- > -- 'getBooksBy (Just "Isaac Asimov")' to get all books by Isaac Asimov
372+instance (KnownSymbol sym, ToHttpApiData a, HasClient t m sublayout tag, Reflex t)
373+ => HasClient t m (QueryParam sym a :> sublayout) tag where
374+
375+ type Client t m (QueryParam sym a :> sublayout) tag =
376+ Dynamic t (QParam a) -> Client t m sublayout tag
377+
378+ -- if mparam = Nothing, we don't add it to the query string
379+ clientWithRouteAndResultHandler Proxy q t req baseurl opts wrap mparam =
380+ clientWithRouteAndResultHandler (Proxy :: Proxy sublayout) q t
381+ (req {qParams = paramPair : qParams req}) baseurl opts wrap
382+
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)
388+
389+
390+
391+-- | If you use a 'QueryParams' in one of your endpoints in your API,
392+-- the corresponding querying function will automatically take
393+-- an additional argument, a list of values of the type specified
394+-- by your 'QueryParams'.
509395--
396+-- If you give an empty list, nothing will be added to the query string.
510397--
511−-- -- | If you use a 'ReqBody' in one of your endpoints in your API,
512−-- -- the corresponding querying function will automatically take
513−-- -- an additional argument of the type specified by your 'ReqBody'.
514−-- -- That function will take care of encoding this argument as JSON and
515−-- -- of using it as the request body.
516−-- --
517−-- -- All you need is for your type to have a 'ToJSON' instance.
518−-- --
519−-- -- Example:
520−-- --
521−-- -- > type MyApi = "books" :> ReqBody '[JSON] Book :> Post '[JSON] Book
522−-- -- >
523−-- -- > myApi :: Proxy MyApi
524−-- -- > myApi = Proxy
525−-- -- >
526−-- -- > addBook :: Book -> ExceptT String IO Book
527−-- -- > addBook = client myApi host
528−-- -- > where host = BaseUrl Http "localhost" 8080
529−-- -- > -- then you can just use "addBook" to query that endpoint
530−-- instance (MimeRender ct a, HasReflexClient sublayout)
531−-- => HasReflexClient (ReqBody (ct ': cts) a :> sublayout) where
398+-- Otherwise, this function will take care
399+-- of inserting a textual representation of your values in the query string,
400+-- under the same query string parameter name.
532401--
533−-- type Input (ReqBody (ct ': cts) a :> sublayout) = a ::> Input sublayout
534−-- type Client (ReqBody (ct ': cts) a :> sublayout) = Client sublayout
402+-- You can control how values for your type are turned into
403+-- text by specifying a 'ToHttpApiData' instance for your type.
535404--
536−-- clientWithRoute Proxy req baseurl (body ::> rest) =
537−-- clientWithRoute (Proxy :: Proxy sublayout)
538−-- (let ctProxy = Proxy :: Proxy ct
539−-- in setRQBody (mimeRender ctProxy body)
540−-- (contentType ctProxy)
541−-- req
542−-- )
543−-- baseurl rest
405+-- Example:
544406--
545−-- -- | Make the querying function append @path@ to the request path.
546−-- instance (KnownSymbol path, HasReflexClient sublayout) => HasReflexClient (path :> sublayout) where
547−-- type Input (path :> sublayout) = Input sublayout
548−-- type Client (path :> sublayout) = Client sublayout
407+-- > type MyApi = "books" :> QueryParams "authors" Text :> Get '[JSON] [Book]
408+-- >
409+-- > myApi :: Proxy MyApi
410+-- > myApi = Proxy
411+-- >
412+-- > getBooksBy :: [Text] -> ExceptT String IO [Book]
413+-- > getBooksBy = client myApi host
414+-- > where host = BaseUrl Http "localhost" 8080
415+-- > -- then you can just use "getBooksBy" to query that endpoint.
416+-- > -- 'getBooksBy []' for all books
417+-- > -- 'getBooksBy ["Isaac Asimov", "Robert A. Heinlein"]'
418+-- > -- to get all books by Asimov and Heinlein
419+instance (KnownSymbol sym, ToHttpApiData a, HasClient t m sublayout tag, Reflex t)
420+ => HasClient t m (QueryParams sym a :> sublayout) tag where
421+
422+ type Client t m (QueryParams sym a :> sublayout) tag =
423+ Dynamic t [a] -> Client t m sublayout tag
424+
425+ clientWithRouteAndResultHandler Proxy q t req baseurl opts wrap paramlist =
426+ clientWithRouteAndResultHandler (Proxy :: Proxy sublayout) q t req' baseurl opts wrap
427+
428+ where req' = req { qParams = (T.pack pname, params') : qParams req }
429+ pname = symbolVal (Proxy :: Proxy sym)
430+ params' = QueryPartParams $ (fmap . fmap) toQueryParam
431+ paramlist
432+
433+
434+
435+-- | If you use a 'QueryFlag' in one of your endpoints in your API,
436+-- the corresponding querying function will automatically take
437+-- an additional 'Bool' argument.
549438--
550−-- clientWithRoute Proxy req baseurl val =
551−-- clientWithRoute (Proxy :: Proxy sublayout)
552−-- (appendToPath p req)
553−-- baseurl val
439+-- If you give 'False', nothing will be added to the query string.
554440--
555−-- where p = symbolVal (Proxy :: Proxy path)
441+-- Otherwise, this function will insert a value-less query string
442+-- parameter under the name associated to your 'QueryFlag'.
556443--
557−-- instance HasReflexClient api => HasReflexClient (Vault :> api) where
558−-- type Input (Vault :> api) = Input api
559−-- type Client (Vault :> api) = Client api
444+-- Example:
560445--
561−-- clientWithRoute Proxy req baseurl val =
562−-- clientWithRoute (Proxy :: Proxy api) req baseurl val
446+-- > type MyApi = "books" :> QueryFlag "published" :> Get '[JSON] [Book]
447+-- >
448+-- > myApi :: Proxy MyApi
449+-- > myApi = Proxy
450+-- >
451+-- > getBooks :: Bool -> ExceptT String IO [Book]
452+-- > getBooks = client myApi host
453+-- > where host = BaseUrl Http "localhost" 8080
454+-- > -- then you can just use "getBooks" to query that endpoint.
455+-- > -- 'getBooksBy False' for all books
456+-- > -- 'getBooksBy True' to only get _already published_ books
457+
458+-- TODO Bring back
459+instance (KnownSymbol sym, HasClient t m sublayout tag, Reflex t)
460+ => HasClient t m (QueryFlag sym :> sublayout) tag where
461+
462+ type Client t m (QueryFlag sym :> sublayout) tag =
463+ Dynamic t Bool -> Client t m sublayout tag
464+
465+ clientWithRouteAndResultHandler Proxy q t req baseurl opts wrap flag =
466+ clientWithRouteAndResultHandler (Proxy :: Proxy sublayout) q t req' baseurl opts wrap
467+
468+ where req' = req { qParams = thisPair : qParams req }
469+ thisPair = (T.pack pName, QueryPartFlag flag) :: (Text, QueryPart t)
470+ pName = symbolVal (Proxy :: Proxy sym)
471+
472+
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+
495+
496+-- | If you use a 'ReqBody' in one of your endpoints in your API,
497+-- the corresponding querying function will automatically take
498+-- an additional argument of the type specified by your 'ReqBody'.
499+-- That function will take care of encoding this argument as JSON and
500+-- of using it as the request body.
563501--
564−-- instance HasReflexClient api => HasReflexClient (RemoteHost :> api) where
565−-- type Input (RemoteHost :> api) = Input api
566−-- type Client (RemoteHost :> api) = Client api
502+-- All you need is for your type to have a 'ToJSON' instance.
567503--
568−-- clientWithRoute Proxy req baseurl val =
569−-- clientWithRoute (Proxy :: Proxy api) req baseurl val
504+-- Example:
570505--
571−-- instance HasReflexClient api => HasReflexClient (IsSecure :> api) where
572−-- type Input (IsSecure :> api) = Input api
573−-- type Client (IsSecure :> api) = Client api
506+-- > type MyApi = "books" :> ReqBody '[JSON] Book :> Post '[JSON] Book
507+-- >
508+-- > myApi :: Proxy MyApi
509+-- > myApi = Proxy
510+-- >
511+-- > addBook :: Book -> ExceptT String IO Book
512+-- > addBook = client myApi host
513+-- > where host = BaseUrl Http "localhost" 8080
514+-- > -- then you can just use "addBook" to query that endpoint
515+
516+instance (MimeRender ct a, HasClient t m sublayout tag, Reflex t)
517+ => HasClient t m (ReqBody (ct ': cts) a :> sublayout) tag where
518+
519+ type Client t m (ReqBody (ct ': cts) a :> sublayout) tag =
520+ Dynamic t (Either Text a) -> Client t m sublayout tag
521+
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))
529+ body
530+
531+
532+
533+-- | Make the querying function append @path@ to the request path.
534+instance (KnownSymbol path, HasClient t m sublayout tag, Reflex t) => HasClient t m (path :> sublayout) tag where
535+ type Client t m (path :> sublayout) tag = Client t m sublayout tag
536+
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
540+
541+ where p = symbolVal (Proxy :: Proxy path)
542+
543+
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
553+
554+ clientWithRouteAndResultHandler Proxy =
555+ clientWithRouteAndResultHandler (Proxy :: Proxy api)
556+
557+
558+
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
561+
562+ clientWithRouteAndResultHandler Proxy =
563+ clientWithRouteAndResultHandler (Proxy :: Proxy api)
564+
565+
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
574+ where
575+ req' = req { authData = Just authdata }
576+
577+-- instance HasClient t m subapi =>
578+-- HasClient t m (WithNamedConfig name config subapi) where
579+
580+-- type Client t m (WithNamedConfig name config subapi) = Client t m subapi
581+-- clientWithRoute Proxy q = clientWithRoute (Proxy :: Proxy subapi) q
582+
583+
584+{- Note [Non-Empty Content Types]
585+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
586+Rather than have
587+
588+ instance (..., cts' ~ (ct ': cts)) => ... cts' ...
589+
590+It may seem to make more sense to have:
591+
592+ instance (...) => ... (ct ': cts) ...
593+
594+But this means that if another instance exists that does *not* require
595+non-empty lists, but is otherwise more specific, no instance will be overall
596+more specific. This in turn generally means adding yet another instance (one
597+for empty and one for non-empty lists).
598+-}
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.
574605--
575−-- clientWithRoute Proxy req baseurl val =
576−-- clientWithRoute (Proxy :: Proxy api) req baseurl val
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+