@@ -1,625 +1,593 @@
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.Except
30+import Data.ByteString.Lazy (ByteString)
31+import Data.Default
32+import Data.List
33+import Data.Proxy
34+import Data.String.Conversions
35+import Data.Text (unpack)
36+import GHC.TypeLits
37+import Network.HTTP.Media
38+import qualified Network.HTTP.Types as H
39+import qualified Network.HTTP.Types.Header as HTTP
40+import Servant.API
41+import Servant.Common.BaseUrl
42+import Servant.Common.Req
43+import Reflex
44+import Reflex.Dom
45+import Web.HttpApiData
46+import Reflex.Dom.Contrib.Xhr
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+-- type Client (Get (ct ': cts) result) = Final result
99+-- clientWithRoute Proxy req baseurl _ =
100+-- snd <$> performRequestCT (Proxy :: Proxy ct) H.methodGet req baseurl
101+
102+instance
103+#if MIN_VERSION_base(4,8,0)
104+ {-# OVERLAPPING #-}
105+#endif
106+ HasReflexClient (Get (ct ': cts) ()) where
107+ type Input (Get (ct ': cts) ()) = ()
108+ type Output (Get (ct ': cts) ()) = ()
109+ -- type Client (Get (ct ': cts) ()) = Final ()
110+ clientWithRoute Proxy req baseurl trigEvents =
111+ performAJAX requestBuilder responseParser trigEvents
112+ where
113+ requestBuilder _ = XhrRequest "GET" (showBaseUrl baseurl) def
114+ responseParser _ = ()
115+
116+-- -- | Pick a 'Method' and specify where the server you want to query is. You get
117+-- -- back the full `Response`.
118+-- instance HasReflexClient Raw where
119+-- type Input Raw = H.Method ::> ()
120+-- type Client Raw = Final (Int, ByteString, MediaType, [HTTP.Header], Response ByteString)
121+
122+-- clientWithRoute :: Proxy Raw -> Req -> BaseUrl -> Input Raw -> Client Raw
123+-- clientWithRoute Proxy req baseurl (httpMethod ::> ()) = do
124+-- performRequest httpMethod req baseurl
125+
126+-- -- | If you have a 'Get xs (Headers ls x)' endpoint, the client expects the
127+-- -- corresponding headers.
128+-- instance
129+-- #if MIN_VERSION_base(4,8,0)
130+-- {-# OVERLAPPING #-}
131+-- #endif
132+-- ( MimeUnrender ct a, BuildHeadersTo ls
133+-- ) => HasReflexClient (Get (ct ': cts) (Headers ls a)) where
134+-- type Input (Get (ct ': cts) (Headers ls a)) = ()
135+-- type Client (Get (ct ': cts) (Headers ls a)) = Final (Headers ls a)
136+-- clientWithRoute Proxy req baseurl _ = do
137+-- (hdrs, resp) <- performRequestCT (Proxy :: Proxy ct) H.methodGet req baseurl
138+-- return $ Headers { getResponse = resp
139+-- , getHeadersHList = buildHeadersTo hdrs
140+-- }
350141--
351−-- If you give Nothing, nothing will be added to the query string.
142+-- -- | A client querying function for @a ':<|>' b@ will actually hand you
143+-- -- one function for querying @a@ and another one for querying @b@,
144+-- -- stitching them together with ':<|>', which really is just like a pair.
145+-- --
146+-- -- > type MyApi = "books" :> Get '[JSON] [Book] -- GET /books
147+-- -- > :<|> "books" :> ReqBody '[JSON] Book :> Post Book -- POST /books
148+-- -- >
149+-- -- > myApi :: Proxy MyApi
150+-- -- > myApi = Proxy
151+-- -- >
152+-- -- > getAllBooks :: ExceptT String IO [Book]
153+-- -- > postNewBook :: Book -> ExceptT String IO Book
154+-- -- > (getAllBooks :<|> postNewBook) = client myApi host
155+-- -- > where host = BaseUrl Http "localhost" 8080
156+-- instance (HasReflexClient a, HasReflexClient b) => HasReflexClient (a :<|> b) where
157+-- type Input (a :<|> b) = Input a :<|> Input b
158+-- type Client (a :<|> b) = Client a :<|> Client b
159+-- clientWithRoute Proxy req baseurl (a :<|> b) =
160+-- clientWithRoute (Proxy :: Proxy a) req baseurl a :<|>
161+-- clientWithRoute (Proxy :: Proxy b) req baseurl b
352162--
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.
163+-- ------------------------------------------------------------------------------
164+-- -- | If you use a 'Capture' in one of your endpoints in your API,
165+-- -- the corresponding querying function will automatically take
166+-- -- an additional argument of the type specified by your 'Capture'.
167+-- -- That function will take care of inserting a textual representation
168+-- -- of this value at the right place in the request path.
169+-- --
170+-- -- You can control how values for this type are turned into
171+-- -- text by specifying a 'ToHttpApiData' instance for your type.
172+-- --
173+-- -- Example:
174+-- --
175+-- -- > type MyApi = "books" :> Capture "isbn" Text :> Get '[JSON] Book
176+-- -- >
177+-- -- > myApi :: Proxy MyApi
178+-- -- > myApi = Proxy
179+-- -- >
180+-- -- > getBook :: Text -> ExceptT String IO Book
181+-- -- > getBook = client myApi host
182+-- -- > where host = BaseUrl Http "localhost" 8080
183+-- -- > -- then you can just use "getBook" to query that endpoint
184+-- instance (KnownSymbol capture, ToHttpApiData a, HasReflexClient sublayout)
185+-- => HasReflexClient (Capture capture a :> sublayout) where
355186--
356−-- You can control how values for your type are turned into
357−-- text by specifying a 'ToHttpApiData' instance for your type.
187+-- type Input (Capture cap a :> sublayout) = a ::> Input sublayout
188+-- type Client (Capture capture a :> sublayout) = Client sublayout
358189--
359−-- Example:
190+-- clientWithRoute Proxy req baseurl (val ::> rest) =
191+-- clientWithRoute (Proxy :: Proxy sublayout)
192+-- (appendToPath p req) baseurl rest
360193--
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'.
194+-- where p = unpack (toUrlPiece val)
395195--
396−-- If you give an empty list, nothing will be added to the query string.
196+-- -- | If you have a 'Delete' endpoint in your API, the client
197+-- -- side querying function that is created when calling 'client'
198+-- -- will just require an argument that specifies the scheme, host
199+-- -- and port to send the request to.
200+-- instance
201+-- #if MIN_VERSION_base(4,8,0)
202+-- {-# OVERLAPPABLE #-}
203+-- #endif
204+-- (MimeUnrender ct a, cts' ~ (ct ': cts)) => HasReflexClient (Delete cts' a) where
205+-- type Input (Delete cts' a) = ()
206+-- type Client (Delete cts' a) = Final a
207+-- clientWithRoute Proxy req baseurl val =
208+-- snd <$> performRequestCT (Proxy :: Proxy ct) H.methodDelete req baseurl val
397209--
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.
210+-- instance
211+-- #if MIN_VERSION_base(4,8,0)
212+-- {-# OVERLAPPING #-}
213+-- #endif
214+-- HasReflexClient (Delete cts ()) where
215+-- type Input (Delete cts ()) = ()
216+-- type Client (Delete cts ()) = Final ()
217+-- clientWithRoute Proxy req baseurl val =
218+-- void $ performRequestNoBody H.methodDelete req baseurl val
401219--
402−-- You can control how values for your type are turned into
403−-- text by specifying a 'ToHttpApiData' instance for your type.
220+-- -- | If you have a 'Delete xs (Headers ls x)' endpoint, the client expects the
221+-- -- corresponding headers.
222+-- instance
223+-- #if MIN_VERSION_base(4,8,0)
224+-- {-# OVERLAPPING #-}
225+-- #endif
226+-- ( MimeUnrender ct a, BuildHeadersTo ls, cts' ~ (ct ': cts)
227+-- ) => HasReflexClient (Delete cts' (Headers ls a)) where
228+-- type Input (Delete cts' (Headers ls a)) = ()
229+-- type Client (Delete cts' (Headers ls a)) = Final (Headers ls a)
230+-- clientWithRoute Proxy req baseurl _ = do
231+-- (hdrs, resp) <- performRequestCT (Proxy :: Proxy ct) H.methodDelete req baseurl
232+-- return $ Headers { getResponse = resp
233+-- , getHeadersHList = buildHeadersTo hdrs
234+-- }
404235--
405−-- Example:
236+-- -- | If you use a 'Header' in one of your endpoints in your API,
237+-- -- the corresponding querying function will automatically take
238+-- -- an additional argument of the type specified by your 'Header',
239+-- -- wrapped in Maybe.
240+-- --
241+-- -- That function will take care of encoding this argument as Text
242+-- -- in the request headers.
243+-- --
244+-- -- All you need is for your type to have a 'ToHttpApiData' instance.
245+-- --
246+-- -- Example:
247+-- --
248+-- -- > newtype Referer = Referer { referrer :: Text }
249+-- -- > deriving (Eq, Show, Generic, FromText, ToHttpApiData)
250+-- -- >
251+-- -- > -- GET /view-my-referer
252+-- -- > type MyApi = "view-my-referer" :> Header "Referer" Referer :> Get '[JSON] Referer
253+-- -- >
254+-- -- > myApi :: Proxy MyApi
255+-- -- > myApi = Proxy
256+-- -- >
257+-- -- > viewReferer :: Maybe Referer -> ExceptT String IO Book
258+-- -- > viewReferer = client myApi host
259+-- -- > where host = BaseUrl Http "localhost" 8080
260+-- -- > -- then you can just use "viewRefer" to query that endpoint
261+-- -- > -- specifying Nothing or e.g Just "http://haskell.org/" as arguments
262+-- instance (KnownSymbol sym, ToHttpApiData a, HasReflexClient sublayout)
263+-- => HasReflexClient (Header sym a :> sublayout) where
406264--
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.
265+-- type Input (Header sym a :> sublayout) = Maybe a ::> Input sublayout
266+-- type Client (Header sym a :> sublayout) = Client sublayout
438267--
439−-- If you give 'False', nothing will be added to the query string.
268+-- clientWithRoute Proxy req baseurl (mval ::> rest) =
269+-- clientWithRoute (Proxy :: Proxy sublayout)
270+-- (maybe req
271+-- (\value -> Servant.Common.Req.addHeader hname value req)
272+-- mval
273+-- )
274+-- baseurl rest
440275--
441−-- Otherwise, this function will insert a value-less query string
442−-- parameter under the name associated to your 'QueryFlag'.
276+-- where hname = symbolVal (Proxy :: Proxy sym)
443277--
444−-- Example:
278+-- -- | If you have a 'Post' endpoint in your API, the client
279+-- -- side querying function that is created when calling 'client'
280+-- -- will just require an argument that specifies the scheme, host
281+-- -- and port to send the request to.
282+-- instance
283+-- #if MIN_VERSION_base(4,8,0)
284+-- {-# OVERLAPPABLE #-}
285+-- #endif
286+-- (MimeUnrender ct a) => HasReflexClient (Post (ct ': cts) a) where
287+-- type Input (Post (ct ': cts) a) = ()
288+-- type Client (Post (ct ': cts) a) = Final a
289+-- clientWithRoute Proxy req baseurl _ =
290+-- snd <$> performRequestCT (Proxy :: Proxy ct) H.methodPost req baseurl
445291--
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.
292+-- instance
293+-- #if MIN_VERSION_base(4,8,0)
294+-- {-# OVERLAPPING #-}
295+-- #endif
296+-- HasReflexClient (Post (ct ': cts) ()) where
297+-- type Input (Post (ct ': cts) ()) = ()
298+-- type Client (Post (ct ': cts) ()) = Final ()
299+-- clientWithRoute Proxy req baseurl _ =
300+-- void $ performRequestNoBody H.methodPost req baseurl
501301--
502−-- All you need is for your type to have a 'ToJSON' instance.
302+-- -- | If you have a 'Post xs (Headers ls x)' endpoint, the client expects the
303+-- -- corresponding headers.
304+-- instance
305+-- #if MIN_VERSION_base(4,8,0)
306+-- {-# OVERLAPPING #-}
307+-- #endif
308+-- ( MimeUnrender ct a, BuildHeadersTo ls
309+-- ) => HasReflexClient (Post (ct ': cts) (Headers ls a)) where
310+-- type Input (Post (ct ': cts) (Headers ls a)) = ()
311+-- type Client (Post (ct ': cts) (Headers ls a)) = Final (Headers ls a)
312+-- clientWithRoute Proxy req baseurl _ = do
313+-- (hdrs, resp) <- performRequestCT (Proxy :: Proxy ct) H.methodPost req baseurl
314+-- return $ Headers { getResponse = resp
315+-- , getHeadersHList = buildHeadersTo hdrs
316+-- }
503317--
504−-- Example:
318+-- -- | If you have a 'Put' endpoint in your API, the client
319+-- -- side querying function that is created when calling 'client'
320+-- -- will just require an argument that specifies the scheme, host
321+-- -- and port to send the request to.
322+-- instance
323+-- #if MIN_VERSION_base(4,8,0)
324+-- {-# OVERLAPPABLE #-}
325+-- #endif
326+-- (MimeUnrender ct a) => HasReflexClient (Put (ct ': cts) a) where
327+-- type Input (Put (ct ': cts) a) = ()
328+-- type Client (Put (ct ': cts) a) = Final a
329+-- clientWithRoute Proxy req baseurl _ =
330+-- snd <$> performRequestCT (Proxy :: Proxy ct) H.methodPut req baseurl
505331--
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.
332+-- instance
333+-- #if MIN_VERSION_base(4,8,0)
334+-- {-# OVERLAPPING #-}
335+-- #endif
336+-- HasReflexClient (Put (ct ': cts) ()) where
337+-- type Input (Put (ct ': cts) ()) = ()
338+-- type Client (Put (ct ': cts) ()) = Final ()
339+-- clientWithRoute Proxy req baseurl _ =
340+-- void $ performRequestNoBody H.methodPut req baseurl
605341--
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−
342+-- -- | If you have a 'Put xs (Headers ls x)' endpoint, the client expects the
343+-- -- corresponding headers.
344+-- instance
345+-- #if MIN_VERSION_base(4,8,0)
346+-- {-# OVERLAPPING #-}
347+-- #endif
348+-- ( MimeUnrender ct a, BuildHeadersTo ls
349+-- ) => HasReflexClient (Put (ct ': cts) (Headers ls a)) where
350+-- type Input (Put (ct ': cts) (Headers ls a)) = ()
351+-- type Client (Put (ct ': cts) (Headers ls a)) = Final (Headers ls a)
352+-- clientWithRoute Proxy req baseurl _ = do
353+-- (hdrs, resp) <- performRequestCT (Proxy :: Proxy ct) H.methodPut req baseurl
354+-- return $ Headers { getResponse = resp
355+-- , getHeadersHList = buildHeadersTo hdrs
356+-- }
357+--
358+-- -- | If you have a 'Patch' endpoint in your API, the client
359+-- -- side querying function that is created when calling 'client'
360+-- -- will just require an argument that specifies the scheme, host
361+-- -- and port to send the request to.
362+-- instance
363+-- #if MIN_VERSION_base(4,8,0)
364+-- {-# OVERLAPPABLE #-}
365+-- #endif
366+-- (MimeUnrender ct a) => HasReflexClient (Patch (ct ': cts) a) where
367+-- type Input (Patch (ct ': cts) a) = ()
368+-- type Client (Patch (ct ': cts) a) = Final a
369+-- clientWithRoute Proxy req baseurl _ =
370+-- snd <$> performRequestCT (Proxy :: Proxy ct) H.methodPatch req baseurl
371+--
372+-- instance
373+-- #if MIN_VERSION_base(4,8,0)
374+-- {-# OVERLAPPING #-}
375+-- #endif
376+-- HasReflexClient (Patch (ct ': cts) ()) where
377+-- type Input (Patch (ct ': cts) ()) = ()
378+-- type Client (Patch (ct ': cts) ()) = Final ()
379+-- clientWithRoute Proxy req baseurl _ =
380+-- void $ performRequestNoBody H.methodPatch req baseurl
381+--
382+-- -- | If you have a 'Patch xs (Headers ls x)' endpoint, the client expects the
383+-- -- corresponding headers.
384+-- instance
385+-- #if MIN_VERSION_base(4,8,0)
386+-- {-# OVERLAPPING #-}
387+-- #endif
388+-- ( MimeUnrender ct a, BuildHeadersTo ls
389+-- ) => HasReflexClient (Patch (ct ': cts) (Headers ls a)) where
390+-- type Input (Patch (ct ': cts) (Headers ls a)) = ()
391+-- type Client (Patch (ct ': cts) (Headers ls a)) = Final (Headers ls a)
392+-- clientWithRoute Proxy req baseurl _ = do
393+-- (hdrs, resp) <- performRequestCT (Proxy :: Proxy ct) H.methodPatch req baseurl
394+-- return $ Headers { getResponse = resp
395+-- , getHeadersHList = buildHeadersTo hdrs
396+-- }
397+--
398+-- -- | If you use a 'QueryParam' in one of your endpoints in your API,
399+-- -- the corresponding querying function will automatically take
400+-- -- an additional argument of the type specified by your 'QueryParam',
401+-- -- enclosed in Maybe.
402+-- --
403+-- -- If you give Nothing, nothing will be added to the query string.
404+-- --
405+-- -- If you give a non-'Nothing' value, this function will take care
406+-- -- of inserting a textual representation of this value in the query string.
407+-- --
408+-- -- You can control how values for your type are turned into
409+-- -- text by specifying a 'ToHttpApiData' instance for your type.
410+-- --
411+-- -- Example:
412+-- --
413+-- -- > type MyApi = "books" :> QueryParam "author" Text :> Get '[JSON] [Book]
414+-- -- >
415+-- -- > myApi :: Proxy MyApi
416+-- -- > myApi = Proxy
417+-- -- >
418+-- -- > getBooksBy :: Maybe Text -> ExceptT String IO [Book]
419+-- -- > getBooksBy = client myApi host
420+-- -- > where host = BaseUrl Http "localhost" 8080
421+-- -- > -- then you can just use "getBooksBy" to query that endpoint.
422+-- -- > -- 'getBooksBy Nothing' for all books
423+-- -- > -- 'getBooksBy (Just "Isaac Asimov")' to get all books by Isaac Asimov
424+-- instance (KnownSymbol sym, ToHttpApiData a, HasReflexClient sublayout)
425+-- => HasReflexClient (QueryParam sym a :> sublayout) where
426+--
427+-- type Input (QueryParam sym a :> sublayout) = Maybe a ::> Input sublayout
428+-- type Client (QueryParam sym a :> sublayout) = Client sublayout
429+--
430+-- -- if mparam = Nothing, we don't add it to the query string
431+-- clientWithRoute Proxy req baseurl (mparam ::> rest) =
432+-- clientWithRoute (Proxy :: Proxy sublayout)
433+-- (maybe req
434+-- (flip (appendToQueryString pname) req . Just)
435+-- mparamText
436+-- )
437+-- baseurl rest
438+--
439+-- where pname = cs pname'
440+-- pname' = symbolVal (Proxy :: Proxy sym)
441+-- mparamText = fmap toQueryParam mparam
442+--
443+-- -- | If you use a 'QueryParams' in one of your endpoints in your API,
444+-- -- the corresponding querying function will automatically take
445+-- -- an additional argument, a list of values of the type specified
446+-- -- by your 'QueryParams'.
447+-- --
448+-- -- If you give an empty list, nothing will be added to the query string.
449+-- --
450+-- -- Otherwise, this function will take care
451+-- -- of inserting a textual representation of your values in the query string,
452+-- -- under the same query string parameter name.
453+-- --
454+-- -- You can control how values for your type are turned into
455+-- -- text by specifying a 'ToHttpApiData' instance for your type.
456+-- --
457+-- -- Example:
458+-- --
459+-- -- > type MyApi = "books" :> QueryParams "authors" Text :> Get '[JSON] [Book]
460+-- -- >
461+-- -- > myApi :: Proxy MyApi
462+-- -- > myApi = Proxy
463+-- -- >
464+-- -- > getBooksBy :: [Text] -> ExceptT String IO [Book]
465+-- -- > getBooksBy = client myApi host
466+-- -- > where host = BaseUrl Http "localhost" 8080
467+-- -- > -- then you can just use "getBooksBy" to query that endpoint.
468+-- -- > -- 'getBooksBy []' for all books
469+-- -- > -- 'getBooksBy ["Isaac Asimov", "Robert A. Heinlein"]'
470+-- -- > -- to get all books by Asimov and Heinlein
471+-- instance (KnownSymbol sym, ToHttpApiData a, HasReflexClient sublayout)
472+-- => HasReflexClient (QueryParams sym a :> sublayout) where
473+--
474+-- type Input (QueryParams sym a :> sublayout) = [a] ::> Input sublayout
475+-- type Client (QueryParams sym a :> sublayout) = Client sublayout
476+--
477+-- clientWithRoute Proxy req baseurl (paramlist ::> rest) =
478+-- clientWithRoute (Proxy :: Proxy sublayout)
479+-- (foldl' (\ req' -> maybe req' (flip (appendToQueryString pname) req' . Just))
480+-- req
481+-- paramlist'
482+-- )
483+-- baseurl rest
484+--
485+-- where pname = cs pname'
486+-- pname' = symbolVal (Proxy :: Proxy sym)
487+-- paramlist' = map (Just . toQueryParam) paramlist
488+--
489+-- -- | If you use a 'QueryFlag' in one of your endpoints in your API,
490+-- -- the corresponding querying function will automatically take
491+-- -- an additional 'Bool' argument.
492+-- --
493+-- -- If you give 'False', nothing will be added to the query string.
494+-- --
495+-- -- Otherwise, this function will insert a value-less query string
496+-- -- parameter under the name associated to your 'QueryFlag'.
497+-- --
498+-- -- Example:
499+-- --
500+-- -- > type MyApi = "books" :> QueryFlag "published" :> Get '[JSON] [Book]
501+-- -- >
502+-- -- > myApi :: Proxy MyApi
503+-- -- > myApi = Proxy
504+-- -- >
505+-- -- > getBooks :: Bool -> ExceptT String IO [Book]
506+-- -- > getBooks = client myApi host
507+-- -- > where host = BaseUrl Http "localhost" 8080
508+-- -- > -- then you can just use "getBooks" to query that endpoint.
509+-- -- > -- 'getBooksBy False' for all books
510+-- -- > -- 'getBooksBy True' to only get _already published_ books
511+-- instance (KnownSymbol sym, HasReflexClient sublayout)
512+-- => HasReflexClient (QueryFlag sym :> sublayout) where
513+--
514+-- type Input (QueryFlag sym :> sublayout) = Bool ::> Input sublayout
515+-- type Client (QueryFlag sym :> sublayout) = Client sublayout
516+--
517+-- clientWithRoute Proxy req baseurl (flag ::> rest) =
518+-- clientWithRoute (Proxy :: Proxy sublayout)
519+-- (if flag
520+-- then appendToQueryString paramname Nothing req
521+-- else req
522+-- )
523+-- baseurl rest
524+--
525+-- where paramname = cs $ symbolVal (Proxy :: Proxy sym)
526+--
527+--
528+-- -- | If you use a 'ReqBody' in one of your endpoints in your API,
529+-- -- the corresponding querying function will automatically take
530+-- -- an additional argument of the type specified by your 'ReqBody'.
531+-- -- That function will take care of encoding this argument as JSON and
532+-- -- of using it as the request body.
533+-- --
534+-- -- All you need is for your type to have a 'ToJSON' instance.
535+-- --
536+-- -- Example:
537+-- --
538+-- -- > type MyApi = "books" :> ReqBody '[JSON] Book :> Post '[JSON] Book
539+-- -- >
540+-- -- > myApi :: Proxy MyApi
541+-- -- > myApi = Proxy
542+-- -- >
543+-- -- > addBook :: Book -> ExceptT String IO Book
544+-- -- > addBook = client myApi host
545+-- -- > where host = BaseUrl Http "localhost" 8080
546+-- -- > -- then you can just use "addBook" to query that endpoint
547+-- instance (MimeRender ct a, HasReflexClient sublayout)
548+-- => HasReflexClient (ReqBody (ct ': cts) a :> sublayout) where
549+--
550+-- type Input (ReqBody (ct ': cts) a :> sublayout) = a ::> Input sublayout
551+-- type Client (ReqBody (ct ': cts) a :> sublayout) = Client sublayout
552+--
553+-- clientWithRoute Proxy req baseurl (body ::> rest) =
554+-- clientWithRoute (Proxy :: Proxy sublayout)
555+-- (let ctProxy = Proxy :: Proxy ct
556+-- in setRQBody (mimeRender ctProxy body)
557+-- (contentType ctProxy)
558+-- req
559+-- )
560+-- baseurl rest
561+--
562+-- -- | Make the querying function append @path@ to the request path.
563+-- instance (KnownSymbol path, HasReflexClient sublayout) => HasReflexClient (path :> sublayout) where
564+-- type Input (path :> sublayout) = Input sublayout
565+-- type Client (path :> sublayout) = Client sublayout
566+--
567+-- clientWithRoute Proxy req baseurl val =
568+-- clientWithRoute (Proxy :: Proxy sublayout)
569+-- (appendToPath p req)
570+-- baseurl val
571+--
572+-- where p = symbolVal (Proxy :: Proxy path)
573+--
574+-- instance HasReflexClient api => HasReflexClient (Vault :> api) where
575+-- type Input (Vault :> api) = Input api
576+-- type Client (Vault :> api) = Client api
577+--
578+-- clientWithRoute Proxy req baseurl val =
579+-- clientWithRoute (Proxy :: Proxy api) req baseurl val
580+--
581+-- instance HasReflexClient api => HasReflexClient (RemoteHost :> api) where
582+-- type Input (RemoteHost :> api) = Input api
583+-- type Client (RemoteHost :> api) = Client api
584+--
585+-- clientWithRoute Proxy req baseurl val =
586+-- clientWithRoute (Proxy :: Proxy api) req baseurl val
587+--
588+-- instance HasReflexClient api => HasReflexClient (IsSecure :> api) where
589+-- type Input (IsSecure :> api) = Input api
590+-- type Client (IsSecure :> api) = Client api
591+--
592+-- clientWithRoute Proxy req baseurl val =
593+-- clientWithRoute (Proxy :: Proxy api) req baseurl val