@@ -1,625 +1,608 @@
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 #-}
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+{-# LANGUAGE RankNTypes #-}
12+#if !MIN_VERSION_base(4,8,0)
13+{-# LANGUAGE OverlappingInstances #-}
2014#endif
21−
22−-- #include "overlapping-compat.h"
2315-- | This module provides 'client' which can automatically generate
2416-- querying functions for each endpoint just from the type representing your
2517-- API.
2618module Servant.Reflex
2719 ( client
28− , clientWithOpts
29− , clientWithOptsAndResultHandler
30− , clientWithRoute
31− , clientWithRouteAndResultHandler
32− , BuildHeaderKeysTo(..)
33− , toHeaders
34− , HasClient
35− , Client
36− , module Servant.Common.Req
20+ , HasReflexClient(..)
21+ , ServantError(..)
3722 , module Servant.Common.BaseUrl
3823 ) where
3924
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−
25+#if !MIN_VERSION_base(4,8,0)
26+import Control.Applicative ((<$>))
27+#endif
28+import Control.Monad
29+import Control.Monad.Trans (liftIO)
30+import Control.Monad.Trans.Except
31+import Data.ByteString.Lazy (ByteString)
32+import Data.Default
33+import Data.List
34+import Data.Proxy
35+import Data.String.Conversions
36+import Data.Text (unpack)
37+import GHC.TypeLits
38+import Network.HTTP.Media
39+import qualified Network.HTTP.Types as H
40+import qualified Network.HTTP.Types.Header as HTTP
41+import Servant.API
42+import Servant.Common.BaseUrl
43+import Servant.Common.Req
44+import Reflex
45+import Reflex.Dom
46+import Web.HttpApiData
47+import Reflex.Dom.Xhr
9348
9449-- * Accessing APIs as a Client
9550
9651-- | 'client' allows you to produce operations to query an API from a client.
9752--
9853-- > type MyApi = "books" :> Get '[JSON] [Book] -- GET /books
99−-- > :<|> "books" :> ReqBody '[JSON] Book :> Post '[JSON] Book -- POST /books
54+-- > :<|> "books" :> ReqBody '[JSON] Book :> Post Book -- POST /books
10055-- >
10156-- > myApi :: Proxy MyApi
10257-- > myApi = Proxy
10358-- >
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)))
59+-- > getAllBooks :: ExceptT String IO [Book]
60+-- > postNewBook :: Book -> ExceptT String IO Book
10761-- > (getAllBooks :<|> postNewBook) = client myApi host
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
62+-- > where host = BaseUrl Http "localhost" 8080
63+client :: HasReflexClient layout
64+ => Proxy layout
65+ -> BaseUrl
66+ -- -> Input layout
67+ -> Client (Input layout) (Output layout)
68+client p baseurl = clientWithRoute p defReq baseurl
11769
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
70+data a ::> b = a ::> b deriving (Eq,Ord,Show,Read)
12771
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
72+infixr 3 ::>
14173
14274
75+type Client ins outs = MonadWidget t m => Event t ins -> m (Event t (ins,outs))
76+
14377-- | This class lets us define how each API combinator
14478-- influences the creation of an HTTP request. It's mostly
14579-- an internal class, you can just use 'client'.
146−class Monad m => HasClient t m layout (tag :: *) where
147− type Client t m layout tag :: *
148− clientWithRoute
149− :: Proxy layout
150− -> Proxy m
151− -> Proxy tag
152− -> Req t
153− -> Dynamic t BaseUrl
154− -> ClientOptions
155− -> Client t m layout tag
156− clientWithRoute l m t r b o = clientWithRouteAndResultHandler l m t r b o return
157−
158− clientWithRouteAndResultHandler
159− :: Proxy layout
160− -> Proxy m
161− -> Proxy tag
162− -> Req t
163− -> Dynamic t BaseUrl
164− -> ClientOptions
165− -> (forall a. Event t (ReqResult tag a) -> m (Event t (ReqResult tag a)))
166− -> Client t m layout tag
167−
168−
169−instance (HasClient t m a tag, HasClient t m b tag) => HasClient t m (a :<|> b) tag where
170− type Client t m (a :<|> b) tag = Client t m a tag :<|> Client t m b tag
171−
172− clientWithRouteAndResultHandler Proxy q pTag req baseurl opts wrap =
173− clientWithRouteAndResultHandler (Proxy :: Proxy a) q pTag req baseurl opts wrap :<|>
174− clientWithRouteAndResultHandler (Proxy :: Proxy b) q pTag req baseurl opts wrap
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.
80+class HasReflexClient layout where
81+ type Input layout :: *
82+ type Output layout :: *
83+ clientWithRoute :: Proxy layout -> Req -> BaseUrl -- -> Input layout
84+ -> Client (Input layout) (Output layout)
85+
86+
87+-- | If you have a 'Get' endpoint in your API, the client
88+-- side querying function that is created when calling 'client'
89+-- will just require an argument that specifies the scheme, host
90+-- and port to send the request to.
91+instance
92+#if MIN_VERSION_base(4,8,0)
93+ {-# OVERLAPPABLE #-}
94+#endif
95+ (MimeUnrender ct result) => HasReflexClient (Get (ct ': cts) result) where
96+ type Input (Get (ct ': cts) result) = ()
97+ type Output (Get (ct ': cts) result) = result
98+ clientWithRoute Proxy req baseurl trigEvents = undefined -- performAJAX requestBuilder responseParser
99+-- where
100+-- requestBuilder _ = XhrRequest "GET" (showBaseUrl baseurl) def
101+-- responseParser xhrResp = undefined
102+
103+performAJAX
104+ :: (MonadWidget t m)
105+ => (a -> XhrRequest)
106+ -- ^ Function to build the request
107+ -> (XhrResponse -> b)
108+ -- ^ Function to parse the response
109+ -> Event t a
110+ -> m (Event t (a, b))
111+performAJAX mkRequest parseResponse req =
112+ performEventAsync $ ffor req $ \a cb -> do
113+ _ <- newXMLHttpRequest (mkRequest a) $ \response ->
114+ liftIO $ cb (a, parseResponse response)
115+ return ()
116+
117+
118+instance
119+#if MIN_VERSION_base(4,8,0)
120+ {-# OVERLAPPING #-}
121+#endif
122+ HasReflexClient (Get (ct ': cts) ()) where
123+ type Input (Get (ct ': cts) ()) = ()
124+ type Output (Get (ct ': cts) ()) = ()
125+ clientWithRoute Proxy req baseurl trigEvents =
126+ performAJAX requestBuilder responseParser trigEvents
127+ where
128+ requestBuilder _ = XhrRequest "GET" (showBaseUrl baseurl) def
129+ responseParser _ = ()
130+
131+-- -- | Pick a 'Method' and specify where the server you want to query is. You get
132+-- -- back the full `Response`.
133+-- instance HasReflexClient Raw where
134+-- type Input Raw = H.Method ::> ()
135+-- type Client Raw = Final (Int, ByteString, MediaType, [HTTP.Header], Response ByteString)
136+
137+-- clientWithRoute :: Proxy Raw -> Req -> BaseUrl -> Input Raw -> Client Raw
138+-- clientWithRoute Proxy req baseurl (httpMethod ::> ()) = do
139+-- performRequest httpMethod req baseurl
140+
141+-- -- | If you have a 'Get xs (Headers ls x)' endpoint, the client expects the
142+-- -- corresponding headers.
143+-- instance
144+-- #if MIN_VERSION_base(4,8,0)
145+-- {-# OVERLAPPING #-}
146+-- #endif
147+-- ( MimeUnrender ct a, BuildHeadersTo ls
148+-- ) => HasReflexClient (Get (ct ': cts) (Headers ls a)) where
149+-- type Input (Get (ct ': cts) (Headers ls a)) = ()
150+-- type Client (Get (ct ': cts) (Headers ls a)) = Final (Headers ls a)
151+-- clientWithRoute Proxy req baseurl _ = do
152+-- (hdrs, resp) <- performRequestCT (Proxy :: Proxy ct) H.methodGet req baseurl
153+-- return $ Headers { getResponse = resp
154+-- , getHeadersHList = buildHeadersTo hdrs
155+-- }
350156--
351−-- If you give Nothing, nothing will be added to the query string.
157+-- -- | A client querying function for @a ':<|>' b@ will actually hand you
158+-- -- one function for querying @a@ and another one for querying @b@,
159+-- -- stitching them together with ':<|>', which really is just like a pair.
160+-- --
161+-- -- > type MyApi = "books" :> Get '[JSON] [Book] -- GET /books
162+-- -- > :<|> "books" :> ReqBody '[JSON] Book :> Post Book -- POST /books
163+-- -- >
164+-- -- > myApi :: Proxy MyApi
165+-- -- > myApi = Proxy
166+-- -- >
167+-- -- > getAllBooks :: ExceptT String IO [Book]
168+-- -- > postNewBook :: Book -> ExceptT String IO Book
169+-- -- > (getAllBooks :<|> postNewBook) = client myApi host
170+-- -- > where host = BaseUrl Http "localhost" 8080
171+-- instance (HasReflexClient a, HasReflexClient b) => HasReflexClient (a :<|> b) where
172+-- type Input (a :<|> b) = Input a :<|> Input b
173+-- type Client (a :<|> b) = Client a :<|> Client b
174+-- clientWithRoute Proxy req baseurl (a :<|> b) =
175+-- clientWithRoute (Proxy :: Proxy a) req baseurl a :<|>
176+-- clientWithRoute (Proxy :: Proxy b) req baseurl b
352177--
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.
178+-- ------------------------------------------------------------------------------
179+-- -- | If you use a 'Capture' in one of your endpoints in your API,
180+-- -- the corresponding querying function will automatically take
181+-- -- an additional argument of the type specified by your 'Capture'.
182+-- -- That function will take care of inserting a textual representation
183+-- -- of this value at the right place in the request path.
184+-- --
185+-- -- You can control how values for this type are turned into
186+-- -- text by specifying a 'ToHttpApiData' instance for your type.
187+-- --
188+-- -- Example:
189+-- --
190+-- -- > type MyApi = "books" :> Capture "isbn" Text :> Get '[JSON] Book
191+-- -- >
192+-- -- > myApi :: Proxy MyApi
193+-- -- > myApi = Proxy
194+-- -- >
195+-- -- > getBook :: Text -> ExceptT String IO Book
196+-- -- > getBook = client myApi host
197+-- -- > where host = BaseUrl Http "localhost" 8080
198+-- -- > -- then you can just use "getBook" to query that endpoint
199+-- instance (KnownSymbol capture, ToHttpApiData a, HasReflexClient sublayout)
200+-- => HasReflexClient (Capture capture a :> sublayout) where
355201--
356−-- You can control how values for your type are turned into
357−-- text by specifying a 'ToHttpApiData' instance for your type.
202+-- type Input (Capture cap a :> sublayout) = a ::> Input sublayout
203+-- type Client (Capture capture a :> sublayout) = Client sublayout
358204--
359−-- Example:
205+-- clientWithRoute Proxy req baseurl (val ::> rest) =
206+-- clientWithRoute (Proxy :: Proxy sublayout)
207+-- (appendToPath p req) baseurl rest
360208--
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'.
209+-- where p = unpack (toUrlPiece val)
395210--
396−-- If you give an empty list, nothing will be added to the query string.
211+-- -- | If you have a 'Delete' endpoint in your API, the client
212+-- -- side querying function that is created when calling 'client'
213+-- -- will just require an argument that specifies the scheme, host
214+-- -- and port to send the request to.
215+-- instance
216+-- #if MIN_VERSION_base(4,8,0)
217+-- {-# OVERLAPPABLE #-}
218+-- #endif
219+-- (MimeUnrender ct a, cts' ~ (ct ': cts)) => HasReflexClient (Delete cts' a) where
220+-- type Input (Delete cts' a) = ()
221+-- type Client (Delete cts' a) = Final a
222+-- clientWithRoute Proxy req baseurl val =
223+-- snd <$> performRequestCT (Proxy :: Proxy ct) H.methodDelete req baseurl val
397224--
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.
225+-- instance
226+-- #if MIN_VERSION_base(4,8,0)
227+-- {-# OVERLAPPING #-}
228+-- #endif
229+-- HasReflexClient (Delete cts ()) where
230+-- type Input (Delete cts ()) = ()
231+-- type Client (Delete cts ()) = Final ()
232+-- clientWithRoute Proxy req baseurl val =
233+-- void $ performRequestNoBody H.methodDelete req baseurl val
401234--
402−-- You can control how values for your type are turned into
403−-- text by specifying a 'ToHttpApiData' instance for your type.
235+-- -- | If you have a 'Delete xs (Headers ls x)' endpoint, the client expects the
236+-- -- corresponding headers.
237+-- instance
238+-- #if MIN_VERSION_base(4,8,0)
239+-- {-# OVERLAPPING #-}
240+-- #endif
241+-- ( MimeUnrender ct a, BuildHeadersTo ls, cts' ~ (ct ': cts)
242+-- ) => HasReflexClient (Delete cts' (Headers ls a)) where
243+-- type Input (Delete cts' (Headers ls a)) = ()
244+-- type Client (Delete cts' (Headers ls a)) = Final (Headers ls a)
245+-- clientWithRoute Proxy req baseurl _ = do
246+-- (hdrs, resp) <- performRequestCT (Proxy :: Proxy ct) H.methodDelete req baseurl
247+-- return $ Headers { getResponse = resp
248+-- , getHeadersHList = buildHeadersTo hdrs
249+-- }
404250--
405−-- Example:
251+-- -- | If you use a 'Header' in one of your endpoints in your API,
252+-- -- the corresponding querying function will automatically take
253+-- -- an additional argument of the type specified by your 'Header',
254+-- -- wrapped in Maybe.
255+-- --
256+-- -- That function will take care of encoding this argument as Text
257+-- -- in the request headers.
258+-- --
259+-- -- All you need is for your type to have a 'ToHttpApiData' instance.
260+-- --
261+-- -- Example:
262+-- --
263+-- -- > newtype Referer = Referer { referrer :: Text }
264+-- -- > deriving (Eq, Show, Generic, FromText, ToHttpApiData)
265+-- -- >
266+-- -- > -- GET /view-my-referer
267+-- -- > type MyApi = "view-my-referer" :> Header "Referer" Referer :> Get '[JSON] Referer
268+-- -- >
269+-- -- > myApi :: Proxy MyApi
270+-- -- > myApi = Proxy
271+-- -- >
272+-- -- > viewReferer :: Maybe Referer -> ExceptT String IO Book
273+-- -- > viewReferer = client myApi host
274+-- -- > where host = BaseUrl Http "localhost" 8080
275+-- -- > -- then you can just use "viewRefer" to query that endpoint
276+-- -- > -- specifying Nothing or e.g Just "http://haskell.org/" as arguments
277+-- instance (KnownSymbol sym, ToHttpApiData a, HasReflexClient sublayout)
278+-- => HasReflexClient (Header sym a :> sublayout) where
406279--
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.
280+-- type Input (Header sym a :> sublayout) = Maybe a ::> Input sublayout
281+-- type Client (Header sym a :> sublayout) = Client sublayout
438282--
439−-- If you give 'False', nothing will be added to the query string.
283+-- clientWithRoute Proxy req baseurl (mval ::> rest) =
284+-- clientWithRoute (Proxy :: Proxy sublayout)
285+-- (maybe req
286+-- (\value -> Servant.Common.Req.addHeader hname value req)
287+-- mval
288+-- )
289+-- baseurl rest
440290--
441−-- Otherwise, this function will insert a value-less query string
442−-- parameter under the name associated to your 'QueryFlag'.
291+-- where hname = symbolVal (Proxy :: Proxy sym)
443292--
444−-- Example:
293+-- -- | If you have a 'Post' endpoint in your API, the client
294+-- -- side querying function that is created when calling 'client'
295+-- -- will just require an argument that specifies the scheme, host
296+-- -- and port to send the request to.
297+-- instance
298+-- #if MIN_VERSION_base(4,8,0)
299+-- {-# OVERLAPPABLE #-}
300+-- #endif
301+-- (MimeUnrender ct a) => HasReflexClient (Post (ct ': cts) a) where
302+-- type Input (Post (ct ': cts) a) = ()
303+-- type Client (Post (ct ': cts) a) = Final a
304+-- clientWithRoute Proxy req baseurl _ =
305+-- snd <$> performRequestCT (Proxy :: Proxy ct) H.methodPost req baseurl
445306--
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.
307+-- instance
308+-- #if MIN_VERSION_base(4,8,0)
309+-- {-# OVERLAPPING #-}
310+-- #endif
311+-- HasReflexClient (Post (ct ': cts) ()) where
312+-- type Input (Post (ct ': cts) ()) = ()
313+-- type Client (Post (ct ': cts) ()) = Final ()
314+-- clientWithRoute Proxy req baseurl _ =
315+-- void $ performRequestNoBody H.methodPost req baseurl
501316--
502−-- All you need is for your type to have a 'ToJSON' instance.
317+-- -- | If you have a 'Post xs (Headers ls x)' endpoint, the client expects the
318+-- -- corresponding headers.
319+-- instance
320+-- #if MIN_VERSION_base(4,8,0)
321+-- {-# OVERLAPPING #-}
322+-- #endif
323+-- ( MimeUnrender ct a, BuildHeadersTo ls
324+-- ) => HasReflexClient (Post (ct ': cts) (Headers ls a)) where
325+-- type Input (Post (ct ': cts) (Headers ls a)) = ()
326+-- type Client (Post (ct ': cts) (Headers ls a)) = Final (Headers ls a)
327+-- clientWithRoute Proxy req baseurl _ = do
328+-- (hdrs, resp) <- performRequestCT (Proxy :: Proxy ct) H.methodPost req baseurl
329+-- return $ Headers { getResponse = resp
330+-- , getHeadersHList = buildHeadersTo hdrs
331+-- }
503332--
504−-- Example:
333+-- -- | If you have a 'Put' endpoint in your API, the client
334+-- -- side querying function that is created when calling 'client'
335+-- -- will just require an argument that specifies the scheme, host
336+-- -- and port to send the request to.
337+-- instance
338+-- #if MIN_VERSION_base(4,8,0)
339+-- {-# OVERLAPPABLE #-}
340+-- #endif
341+-- (MimeUnrender ct a) => HasReflexClient (Put (ct ': cts) a) where
342+-- type Input (Put (ct ': cts) a) = ()
343+-- type Client (Put (ct ': cts) a) = Final a
344+-- clientWithRoute Proxy req baseurl _ =
345+-- snd <$> performRequestCT (Proxy :: Proxy ct) H.methodPut req baseurl
505346--
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.
347+-- instance
348+-- #if MIN_VERSION_base(4,8,0)
349+-- {-# OVERLAPPING #-}
350+-- #endif
351+-- HasReflexClient (Put (ct ': cts) ()) where
352+-- type Input (Put (ct ': cts) ()) = ()
353+-- type Client (Put (ct ': cts) ()) = Final ()
354+-- clientWithRoute Proxy req baseurl _ =
355+-- void $ performRequestNoBody H.methodPut req baseurl
605356--
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−
357+-- -- | If you have a 'Put xs (Headers ls x)' endpoint, the client expects the
358+-- -- corresponding headers.
359+-- instance
360+-- #if MIN_VERSION_base(4,8,0)
361+-- {-# OVERLAPPING #-}
362+-- #endif
363+-- ( MimeUnrender ct a, BuildHeadersTo ls
364+-- ) => HasReflexClient (Put (ct ': cts) (Headers ls a)) where
365+-- type Input (Put (ct ': cts) (Headers ls a)) = ()
366+-- type Client (Put (ct ': cts) (Headers ls a)) = Final (Headers ls a)
367+-- clientWithRoute Proxy req baseurl _ = do
368+-- (hdrs, resp) <- performRequestCT (Proxy :: Proxy ct) H.methodPut req baseurl
369+-- return $ Headers { getResponse = resp
370+-- , getHeadersHList = buildHeadersTo hdrs
371+-- }
372+--
373+-- -- | If you have a 'Patch' endpoint in your API, the client
374+-- -- side querying function that is created when calling 'client'
375+-- -- will just require an argument that specifies the scheme, host
376+-- -- and port to send the request to.
377+-- instance
378+-- #if MIN_VERSION_base(4,8,0)
379+-- {-# OVERLAPPABLE #-}
380+-- #endif
381+-- (MimeUnrender ct a) => HasReflexClient (Patch (ct ': cts) a) where
382+-- type Input (Patch (ct ': cts) a) = ()
383+-- type Client (Patch (ct ': cts) a) = Final a
384+-- clientWithRoute Proxy req baseurl _ =
385+-- snd <$> performRequestCT (Proxy :: Proxy ct) H.methodPatch req baseurl
386+--
387+-- instance
388+-- #if MIN_VERSION_base(4,8,0)
389+-- {-# OVERLAPPING #-}
390+-- #endif
391+-- HasReflexClient (Patch (ct ': cts) ()) where
392+-- type Input (Patch (ct ': cts) ()) = ()
393+-- type Client (Patch (ct ': cts) ()) = Final ()
394+-- clientWithRoute Proxy req baseurl _ =
395+-- void $ performRequestNoBody H.methodPatch req baseurl
396+--
397+-- -- | If you have a 'Patch xs (Headers ls x)' endpoint, the client expects the
398+-- -- corresponding headers.
399+-- instance
400+-- #if MIN_VERSION_base(4,8,0)
401+-- {-# OVERLAPPING #-}
402+-- #endif
403+-- ( MimeUnrender ct a, BuildHeadersTo ls
404+-- ) => HasReflexClient (Patch (ct ': cts) (Headers ls a)) where
405+-- type Input (Patch (ct ': cts) (Headers ls a)) = ()
406+-- type Client (Patch (ct ': cts) (Headers ls a)) = Final (Headers ls a)
407+-- clientWithRoute Proxy req baseurl _ = do
408+-- (hdrs, resp) <- performRequestCT (Proxy :: Proxy ct) H.methodPatch req baseurl
409+-- return $ Headers { getResponse = resp
410+-- , getHeadersHList = buildHeadersTo hdrs
411+-- }
412+--
413+-- -- | If you use a 'QueryParam' in one of your endpoints in your API,
414+-- -- the corresponding querying function will automatically take
415+-- -- an additional argument of the type specified by your 'QueryParam',
416+-- -- enclosed in Maybe.
417+-- --
418+-- -- If you give Nothing, nothing will be added to the query string.
419+-- --
420+-- -- If you give a non-'Nothing' value, this function will take care
421+-- -- of inserting a textual representation of this value in the query string.
422+-- --
423+-- -- You can control how values for your type are turned into
424+-- -- text by specifying a 'ToHttpApiData' instance for your type.
425+-- --
426+-- -- Example:
427+-- --
428+-- -- > type MyApi = "books" :> QueryParam "author" Text :> Get '[JSON] [Book]
429+-- -- >
430+-- -- > myApi :: Proxy MyApi
431+-- -- > myApi = Proxy
432+-- -- >
433+-- -- > getBooksBy :: Maybe Text -> ExceptT String IO [Book]
434+-- -- > getBooksBy = client myApi host
435+-- -- > where host = BaseUrl Http "localhost" 8080
436+-- -- > -- then you can just use "getBooksBy" to query that endpoint.
437+-- -- > -- 'getBooksBy Nothing' for all books
438+-- -- > -- 'getBooksBy (Just "Isaac Asimov")' to get all books by Isaac Asimov
439+-- instance (KnownSymbol sym, ToHttpApiData a, HasReflexClient sublayout)
440+-- => HasReflexClient (QueryParam sym a :> sublayout) where
441+--
442+-- type Input (QueryParam sym a :> sublayout) = Maybe a ::> Input sublayout
443+-- type Client (QueryParam sym a :> sublayout) = Client sublayout
444+--
445+-- -- if mparam = Nothing, we don't add it to the query string
446+-- clientWithRoute Proxy req baseurl (mparam ::> rest) =
447+-- clientWithRoute (Proxy :: Proxy sublayout)
448+-- (maybe req
449+-- (flip (appendToQueryString pname) req . Just)
450+-- mparamText
451+-- )
452+-- baseurl rest
453+--
454+-- where pname = cs pname'
455+-- pname' = symbolVal (Proxy :: Proxy sym)
456+-- mparamText = fmap toQueryParam mparam
457+--
458+-- -- | If you use a 'QueryParams' in one of your endpoints in your API,
459+-- -- the corresponding querying function will automatically take
460+-- -- an additional argument, a list of values of the type specified
461+-- -- by your 'QueryParams'.
462+-- --
463+-- -- If you give an empty list, nothing will be added to the query string.
464+-- --
465+-- -- Otherwise, this function will take care
466+-- -- of inserting a textual representation of your values in the query string,
467+-- -- under the same query string parameter name.
468+-- --
469+-- -- You can control how values for your type are turned into
470+-- -- text by specifying a 'ToHttpApiData' instance for your type.
471+-- --
472+-- -- Example:
473+-- --
474+-- -- > type MyApi = "books" :> QueryParams "authors" Text :> Get '[JSON] [Book]
475+-- -- >
476+-- -- > myApi :: Proxy MyApi
477+-- -- > myApi = Proxy
478+-- -- >
479+-- -- > getBooksBy :: [Text] -> ExceptT String IO [Book]
480+-- -- > getBooksBy = client myApi host
481+-- -- > where host = BaseUrl Http "localhost" 8080
482+-- -- > -- then you can just use "getBooksBy" to query that endpoint.
483+-- -- > -- 'getBooksBy []' for all books
484+-- -- > -- 'getBooksBy ["Isaac Asimov", "Robert A. Heinlein"]'
485+-- -- > -- to get all books by Asimov and Heinlein
486+-- instance (KnownSymbol sym, ToHttpApiData a, HasReflexClient sublayout)
487+-- => HasReflexClient (QueryParams sym a :> sublayout) where
488+--
489+-- type Input (QueryParams sym a :> sublayout) = [a] ::> Input sublayout
490+-- type Client (QueryParams sym a :> sublayout) = Client sublayout
491+--
492+-- clientWithRoute Proxy req baseurl (paramlist ::> rest) =
493+-- clientWithRoute (Proxy :: Proxy sublayout)
494+-- (foldl' (\ req' -> maybe req' (flip (appendToQueryString pname) req' . Just))
495+-- req
496+-- paramlist'
497+-- )
498+-- baseurl rest
499+--
500+-- where pname = cs pname'
501+-- pname' = symbolVal (Proxy :: Proxy sym)
502+-- paramlist' = map (Just . toQueryParam) paramlist
503+--
504+-- -- | If you use a 'QueryFlag' in one of your endpoints in your API,
505+-- -- the corresponding querying function will automatically take
506+-- -- an additional 'Bool' argument.
507+-- --
508+-- -- If you give 'False', nothing will be added to the query string.
509+-- --
510+-- -- Otherwise, this function will insert a value-less query string
511+-- -- parameter under the name associated to your 'QueryFlag'.
512+-- --
513+-- -- Example:
514+-- --
515+-- -- > type MyApi = "books" :> QueryFlag "published" :> Get '[JSON] [Book]
516+-- -- >
517+-- -- > myApi :: Proxy MyApi
518+-- -- > myApi = Proxy
519+-- -- >
520+-- -- > getBooks :: Bool -> ExceptT String IO [Book]
521+-- -- > getBooks = client myApi host
522+-- -- > where host = BaseUrl Http "localhost" 8080
523+-- -- > -- then you can just use "getBooks" to query that endpoint.
524+-- -- > -- 'getBooksBy False' for all books
525+-- -- > -- 'getBooksBy True' to only get _already published_ books
526+-- instance (KnownSymbol sym, HasReflexClient sublayout)
527+-- => HasReflexClient (QueryFlag sym :> sublayout) where
528+--
529+-- type Input (QueryFlag sym :> sublayout) = Bool ::> Input sublayout
530+-- type Client (QueryFlag sym :> sublayout) = Client sublayout
531+--
532+-- clientWithRoute Proxy req baseurl (flag ::> rest) =
533+-- clientWithRoute (Proxy :: Proxy sublayout)
534+-- (if flag
535+-- then appendToQueryString paramname Nothing req
536+-- else req
537+-- )
538+-- baseurl rest
539+--
540+-- where paramname = cs $ symbolVal (Proxy :: Proxy sym)
541+--
542+--
543+-- -- | If you use a 'ReqBody' in one of your endpoints in your API,
544+-- -- the corresponding querying function will automatically take
545+-- -- an additional argument of the type specified by your 'ReqBody'.
546+-- -- That function will take care of encoding this argument as JSON and
547+-- -- of using it as the request body.
548+-- --
549+-- -- All you need is for your type to have a 'ToJSON' instance.
550+-- --
551+-- -- Example:
552+-- --
553+-- -- > type MyApi = "books" :> ReqBody '[JSON] Book :> Post '[JSON] Book
554+-- -- >
555+-- -- > myApi :: Proxy MyApi
556+-- -- > myApi = Proxy
557+-- -- >
558+-- -- > addBook :: Book -> ExceptT String IO Book
559+-- -- > addBook = client myApi host
560+-- -- > where host = BaseUrl Http "localhost" 8080
561+-- -- > -- then you can just use "addBook" to query that endpoint
562+-- instance (MimeRender ct a, HasReflexClient sublayout)
563+-- => HasReflexClient (ReqBody (ct ': cts) a :> sublayout) where
564+--
565+-- type Input (ReqBody (ct ': cts) a :> sublayout) = a ::> Input sublayout
566+-- type Client (ReqBody (ct ': cts) a :> sublayout) = Client sublayout
567+--
568+-- clientWithRoute Proxy req baseurl (body ::> rest) =
569+-- clientWithRoute (Proxy :: Proxy sublayout)
570+-- (let ctProxy = Proxy :: Proxy ct
571+-- in setRQBody (mimeRender ctProxy body)
572+-- (contentType ctProxy)
573+-- req
574+-- )
575+-- baseurl rest
576+--
577+-- -- | Make the querying function append @path@ to the request path.
578+-- instance (KnownSymbol path, HasReflexClient sublayout) => HasReflexClient (path :> sublayout) where
579+-- type Input (path :> sublayout) = Input sublayout
580+-- type Client (path :> sublayout) = Client sublayout
581+--
582+-- clientWithRoute Proxy req baseurl val =
583+-- clientWithRoute (Proxy :: Proxy sublayout)
584+-- (appendToPath p req)
585+-- baseurl val
586+--
587+-- where p = symbolVal (Proxy :: Proxy path)
588+--
589+-- instance HasReflexClient api => HasReflexClient (Vault :> api) where
590+-- type Input (Vault :> api) = Input api
591+-- type Client (Vault :> api) = Client api
592+--
593+-- clientWithRoute Proxy req baseurl val =
594+-- clientWithRoute (Proxy :: Proxy api) req baseurl val
595+--
596+-- instance HasReflexClient api => HasReflexClient (RemoteHost :> api) where
597+-- type Input (RemoteHost :> api) = Input api
598+-- type Client (RemoteHost :> api) = Client api
599+--
600+-- clientWithRoute Proxy req baseurl val =
601+-- clientWithRoute (Proxy :: Proxy api) req baseurl val
602+--
603+-- instance HasReflexClient api => HasReflexClient (IsSecure :> api) where
604+-- type Input (IsSecure :> api) = Input api
605+-- type Client (IsSecure :> api) = Client api
606+--
607+-- clientWithRoute Proxy req baseurl val =
608+-- clientWithRoute (Proxy :: Proxy api) req baseurl val