@@ -1,625 +1,610 @@
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+ -> Client (Input layout) (Output layout)
67+client p baseurl = clientWithRoute p defReq baseurl
11768
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
69+data a ::> b = a ::> b deriving (Eq,Ord,Show,Read)
12770
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
71+infixr 3 ::>
14172
73+type Client ins outs = MonadWidget t m => Event t ins -> m (Event t (ins,outs))
14274
14375-- | This class lets us define how each API combinator
14476-- influences the creation of an HTTP request. It's mostly
14577-- 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
78+class HasReflexClient layout where
79+ type Input layout :: *
80+ type Output layout :: *
81+ -- clientWithRoute :: MonadWidget t m => Proxy layout -> Req -> BaseUrl
82+ -- -> Event t (Input layout) -> m (Event t (Input layout, Output layout))
83+ clientWithRoute :: MonadWidget t m
84+ => Proxy layout -> Req -> BaseUrl
85+ -> Event t (Input layout) -> m (Event t (Input layout, Output layout))
86+
87+
88+-- | If you have a 'Get' endpoint in your API, the client
89+-- side querying function that is created when calling 'client'
90+-- will just require an argument that specifies the scheme, host
91+-- and port to send the request to.
92+instance
93+#if MIN_VERSION_base(4,8,0)
94+ {-# OVERLAPPABLE #-}
95+#endif
96+ (MimeUnrender ct result) => HasReflexClient (Get (ct ': cts) result) where
97+ type Input (Get (ct ': cts) result) = ()
98+ type Output (Get (ct ': cts) result) = result
99+ -- type Client (Get (ct ': cts) result) = MonadWidget t m => Event t (Input layout) -> m (Event t result)
100+ clientWithRoute Proxy req baseurl trigEvents = undefined -- performAJAX requestBuilder responseParser
101+-- where
102+-- requestBuilder _ = XhrRequest "GET" (showBaseUrl baseurl) def
103+-- responseParser xhrResp = undefined
104+
105+performAJAX
106+ :: (MonadWidget t m)
107+ => (a -> XhrRequest)
108+ -- ^ Function to build the request
109+ -> (XhrResponse -> b)
110+ -- ^ Function to parse the response
111+ -> Event t a
112+ -> m (Event t (a, b))
113+performAJAX mkRequest parseResponse req =
114+ performEventAsync $ ffor req $ \a cb -> do
115+ _ <- newXMLHttpRequest (mkRequest a) $ \response ->
116+ liftIO $ cb (a, parseResponse response)
117+ return ()
118+
119+
120+instance
121+#if MIN_VERSION_base(4,8,0)
122+ {-# OVERLAPPING #-}
123+#endif
124+ HasReflexClient (Get (ct ': cts) ()) where
125+ type Input (Get (ct ': cts) ()) = ()
126+ type Output (Get (ct ': cts) ()) = ()
127+ -- type Client (Get (ct ': cts) ()) = MonadWidget t m => Event t () -> m (Event t ())
128+ clientWithRoute Proxy req baseurl trigEvents =
129+ performAJAX requestBuilder responseParser trigEvents
130+ where
131+ requestBuilder _ = XhrRequest "GET" (showBaseUrl baseurl) def
132+ responseParser _ = ()
133+
134+-- -- | Pick a 'Method' and specify where the server you want to query is. You get
135+-- -- back the full `Response`.
136+-- instance HasReflexClient Raw where
137+-- type Input Raw = H.Method ::> ()
138+-- type Client Raw = Final (Int, ByteString, MediaType, [HTTP.Header], Response ByteString)
139+
140+-- clientWithRoute :: Proxy Raw -> Req -> BaseUrl -> Input Raw -> Client Raw
141+-- clientWithRoute Proxy req baseurl (httpMethod ::> ()) = do
142+-- performRequest httpMethod req baseurl
143+
144+-- -- | If you have a 'Get xs (Headers ls x)' endpoint, the client expects the
145+-- -- corresponding headers.
146+-- instance
147+-- #if MIN_VERSION_base(4,8,0)
148+-- {-# OVERLAPPING #-}
149+-- #endif
150+-- ( MimeUnrender ct a, BuildHeadersTo ls
151+-- ) => HasReflexClient (Get (ct ': cts) (Headers ls a)) where
152+-- type Input (Get (ct ': cts) (Headers ls a)) = ()
153+-- type Client (Get (ct ': cts) (Headers ls a)) = Final (Headers ls a)
154+-- clientWithRoute Proxy req baseurl _ = do
155+-- (hdrs, resp) <- performRequestCT (Proxy :: Proxy ct) H.methodGet req baseurl
156+-- return $ Headers { getResponse = resp
157+-- , getHeadersHList = buildHeadersTo hdrs
158+-- }
159+--
160+-- | A client querying function for @a ':<|>' b@ will actually hand you
161+-- one function for querying @a@ and another one for querying @b@,
162+-- stitching them together with ':<|>', which really is just like a pair.
163+--
164+-- > type MyApi = "books" :> Get '[JSON] [Book] -- GET /books
165+-- > :<|> "books" :> ReqBody '[JSON] Book :> Post Book -- POST /books
297166-- >
167+-- > myApi :: Proxy MyApi
168+-- > myApi = Proxy
298169-- >
299−-- > viewReferer :: Maybe Referer -> ExceptT String IO Book
300−-- > viewReferer = client myApi host
170+-- > getAllBooks :: ExceptT String IO [Book]
171+-- > postNewBook :: Book -> ExceptT String IO Book
172+-- > (getAllBooks :<|> postNewBook) = client myApi host
301173-- > 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.
174+instance (HasReflexClient a, HasReflexClient b) => HasReflexClient (a :<|> b) where
175+ type Input (a :<|> b) = Input a :<|> Input b
176+ type Output (a :<|> b) = Output a :<|> Output b
177+ clientWithRoute Proxy req baseurl (a :<|> b) = undefined
178+-- clientWithRoute (Proxy :: Proxy a) req baseurl a :<|>
179+-- clientWithRoute (Proxy :: Proxy b) req baseurl b
180+
181+-- ------------------------------------------------------------------------------
182+-- -- | If you use a 'Capture' in one of your endpoints in your API,
183+-- -- the corresponding querying function will automatically take
184+-- -- an additional argument of the type specified by your 'Capture'.
185+-- -- That function will take care of inserting a textual representation
186+-- -- of this value at the right place in the request path.
187+-- --
188+-- -- You can control how values for this type are turned into
189+-- -- text by specifying a 'ToHttpApiData' instance for your type.
190+-- --
191+-- -- Example:
192+-- --
193+-- -- > type MyApi = "books" :> Capture "isbn" Text :> Get '[JSON] Book
194+-- -- >
195+-- -- > myApi :: Proxy MyApi
196+-- -- > myApi = Proxy
197+-- -- >
198+-- -- > getBook :: Text -> ExceptT String IO Book
199+-- -- > getBook = client myApi host
200+-- -- > where host = BaseUrl Http "localhost" 8080
201+-- -- > -- then you can just use "getBook" to query that endpoint
202+-- instance (KnownSymbol capture, ToHttpApiData a, HasReflexClient sublayout)
203+-- => HasReflexClient (Capture capture a :> sublayout) where
350204--
351−-- If you give Nothing, nothing will be added to the query string.
205+-- type Input (Capture cap a :> sublayout) = a ::> Input sublayout
206+-- type Client (Capture capture a :> sublayout) = Client sublayout
352207--
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.
208+-- clientWithRoute Proxy req baseurl (val ::> rest) =
209+-- clientWithRoute (Proxy :: Proxy sublayout)
210+-- (appendToPath p req) baseurl rest
355211--
356−-- You can control how values for your type are turned into
357−-- text by specifying a 'ToHttpApiData' instance for your type.
212+-- where p = unpack (toUrlPiece val)
358213--
359−-- Example:
214+-- -- | If you have a 'Delete' endpoint in your API, the client
215+-- -- side querying function that is created when calling 'client'
216+-- -- will just require an argument that specifies the scheme, host
217+-- -- and port to send the request to.
218+-- instance
219+-- #if MIN_VERSION_base(4,8,0)
220+-- {-# OVERLAPPABLE #-}
221+-- #endif
222+-- (MimeUnrender ct a, cts' ~ (ct ': cts)) => HasReflexClient (Delete cts' a) where
223+-- type Input (Delete cts' a) = ()
224+-- type Client (Delete cts' a) = Final a
225+-- clientWithRoute Proxy req baseurl val =
226+-- snd <$> performRequestCT (Proxy :: Proxy ct) H.methodDelete req baseurl val
360227--
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'.
228+-- instance
229+-- #if MIN_VERSION_base(4,8,0)
230+-- {-# OVERLAPPING #-}
231+-- #endif
232+-- HasReflexClient (Delete cts ()) where
233+-- type Input (Delete cts ()) = ()
234+-- type Client (Delete cts ()) = Final ()
235+-- clientWithRoute Proxy req baseurl val =
236+-- void $ performRequestNoBody H.methodDelete req baseurl val
395237--
396−-- If you give an empty list, nothing will be added to the query string.
238+-- -- | If you have a 'Delete xs (Headers ls x)' endpoint, the client expects the
239+-- -- corresponding headers.
240+-- instance
241+-- #if MIN_VERSION_base(4,8,0)
242+-- {-# OVERLAPPING #-}
243+-- #endif
244+-- ( MimeUnrender ct a, BuildHeadersTo ls, cts' ~ (ct ': cts)
245+-- ) => HasReflexClient (Delete cts' (Headers ls a)) where
246+-- type Input (Delete cts' (Headers ls a)) = ()
247+-- type Client (Delete cts' (Headers ls a)) = Final (Headers ls a)
248+-- clientWithRoute Proxy req baseurl _ = do
249+-- (hdrs, resp) <- performRequestCT (Proxy :: Proxy ct) H.methodDelete req baseurl
250+-- return $ Headers { getResponse = resp
251+-- , getHeadersHList = buildHeadersTo hdrs
252+-- }
397253--
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.
254+-- -- | If you use a 'Header' in one of your endpoints in your API,
255+-- -- the corresponding querying function will automatically take
256+-- -- an additional argument of the type specified by your 'Header',
257+-- -- wrapped in Maybe.
258+-- --
259+-- -- That function will take care of encoding this argument as Text
260+-- -- in the request headers.
261+-- --
262+-- -- All you need is for your type to have a 'ToHttpApiData' instance.
263+-- --
264+-- -- Example:
265+-- --
266+-- -- > newtype Referer = Referer { referrer :: Text }
267+-- -- > deriving (Eq, Show, Generic, FromText, ToHttpApiData)
268+-- -- >
269+-- -- > -- GET /view-my-referer
270+-- -- > type MyApi = "view-my-referer" :> Header "Referer" Referer :> Get '[JSON] Referer
271+-- -- >
272+-- -- > myApi :: Proxy MyApi
273+-- -- > myApi = Proxy
274+-- -- >
275+-- -- > viewReferer :: Maybe Referer -> ExceptT String IO Book
276+-- -- > viewReferer = client myApi host
277+-- -- > where host = BaseUrl Http "localhost" 8080
278+-- -- > -- then you can just use "viewRefer" to query that endpoint
279+-- -- > -- specifying Nothing or e.g Just "http://haskell.org/" as arguments
280+-- instance (KnownSymbol sym, ToHttpApiData a, HasReflexClient sublayout)
281+-- => HasReflexClient (Header sym a :> sublayout) where
401282--
402−-- You can control how values for your type are turned into
403−-- text by specifying a 'ToHttpApiData' instance for your type.
283+-- type Input (Header sym a :> sublayout) = Maybe a ::> Input sublayout
284+-- type Client (Header sym a :> sublayout) = Client sublayout
404285--
405−-- Example:
286+-- clientWithRoute Proxy req baseurl (mval ::> rest) =
287+-- clientWithRoute (Proxy :: Proxy sublayout)
288+-- (maybe req
289+-- (\value -> Servant.Common.Req.addHeader hname value req)
290+-- mval
291+-- )
292+-- baseurl rest
406293--
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.
294+-- where hname = symbolVal (Proxy :: Proxy sym)
438295--
439−-- If you give 'False', nothing will be added to the query string.
296+-- -- | If you have a 'Post' endpoint in your API, the client
297+-- -- side querying function that is created when calling 'client'
298+-- -- will just require an argument that specifies the scheme, host
299+-- -- and port to send the request to.
300+-- instance
301+-- #if MIN_VERSION_base(4,8,0)
302+-- {-# OVERLAPPABLE #-}
303+-- #endif
304+-- (MimeUnrender ct a) => HasReflexClient (Post (ct ': cts) a) where
305+-- type Input (Post (ct ': cts) a) = ()
306+-- type Client (Post (ct ': cts) a) = Final a
307+-- clientWithRoute Proxy req baseurl _ =
308+-- snd <$> performRequestCT (Proxy :: Proxy ct) H.methodPost req baseurl
440309--
441−-- Otherwise, this function will insert a value-less query string
442−-- parameter under the name associated to your 'QueryFlag'.
310+-- instance
311+-- #if MIN_VERSION_base(4,8,0)
312+-- {-# OVERLAPPING #-}
313+-- #endif
314+-- HasReflexClient (Post (ct ': cts) ()) where
315+-- type Input (Post (ct ': cts) ()) = ()
316+-- type Client (Post (ct ': cts) ()) = Final ()
317+-- clientWithRoute Proxy req baseurl _ =
318+-- void $ performRequestNoBody H.methodPost req baseurl
443319--
444−-- Example:
320+-- -- | If you have a 'Post xs (Headers ls x)' endpoint, the client expects the
321+-- -- corresponding headers.
322+-- instance
323+-- #if MIN_VERSION_base(4,8,0)
324+-- {-# OVERLAPPING #-}
325+-- #endif
326+-- ( MimeUnrender ct a, BuildHeadersTo ls
327+-- ) => HasReflexClient (Post (ct ': cts) (Headers ls a)) where
328+-- type Input (Post (ct ': cts) (Headers ls a)) = ()
329+-- type Client (Post (ct ': cts) (Headers ls a)) = Final (Headers ls a)
330+-- clientWithRoute Proxy req baseurl _ = do
331+-- (hdrs, resp) <- performRequestCT (Proxy :: Proxy ct) H.methodPost req baseurl
332+-- return $ Headers { getResponse = resp
333+-- , getHeadersHList = buildHeadersTo hdrs
334+-- }
445335--
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.
336+-- -- | If you have a 'Put' endpoint in your API, the client
337+-- -- side querying function that is created when calling 'client'
338+-- -- will just require an argument that specifies the scheme, host
339+-- -- and port to send the request to.
340+-- instance
341+-- #if MIN_VERSION_base(4,8,0)
342+-- {-# OVERLAPPABLE #-}
343+-- #endif
344+-- (MimeUnrender ct a) => HasReflexClient (Put (ct ': cts) a) where
345+-- type Input (Put (ct ': cts) a) = ()
346+-- type Client (Put (ct ': cts) a) = Final a
347+-- clientWithRoute Proxy req baseurl _ =
348+-- snd <$> performRequestCT (Proxy :: Proxy ct) H.methodPut req baseurl
501349--
502−-- All you need is for your type to have a 'ToJSON' instance.
350+-- instance
351+-- #if MIN_VERSION_base(4,8,0)
352+-- {-# OVERLAPPING #-}
353+-- #endif
354+-- HasReflexClient (Put (ct ': cts) ()) where
355+-- type Input (Put (ct ': cts) ()) = ()
356+-- type Client (Put (ct ': cts) ()) = Final ()
357+-- clientWithRoute Proxy req baseurl _ =
358+-- void $ performRequestNoBody H.methodPut req baseurl
503359--
504−-- Example:
360+-- -- | If you have a 'Put xs (Headers ls x)' endpoint, the client expects the
361+-- -- corresponding headers.
362+-- instance
363+-- #if MIN_VERSION_base(4,8,0)
364+-- {-# OVERLAPPING #-}
365+-- #endif
366+-- ( MimeUnrender ct a, BuildHeadersTo ls
367+-- ) => HasReflexClient (Put (ct ': cts) (Headers ls a)) where
368+-- type Input (Put (ct ': cts) (Headers ls a)) = ()
369+-- type Client (Put (ct ': cts) (Headers ls a)) = Final (Headers ls a)
370+-- clientWithRoute Proxy req baseurl _ = do
371+-- (hdrs, resp) <- performRequestCT (Proxy :: Proxy ct) H.methodPut req baseurl
372+-- return $ Headers { getResponse = resp
373+-- , getHeadersHList = buildHeadersTo hdrs
374+-- }
375+--
376+-- -- | If you have a 'Patch' endpoint in your API, the client
377+-- -- side querying function that is created when calling 'client'
378+-- -- will just require an argument that specifies the scheme, host
379+-- -- and port to send the request to.
380+-- instance
381+-- #if MIN_VERSION_base(4,8,0)
382+-- {-# OVERLAPPABLE #-}
383+-- #endif
384+-- (MimeUnrender ct a) => HasReflexClient (Patch (ct ': cts) a) where
385+-- type Input (Patch (ct ': cts) a) = ()
386+-- type Client (Patch (ct ': cts) a) = Final a
387+-- clientWithRoute Proxy req baseurl _ =
388+-- snd <$> performRequestCT (Proxy :: Proxy ct) H.methodPatch req baseurl
389+--
390+-- instance
391+-- #if MIN_VERSION_base(4,8,0)
392+-- {-# OVERLAPPING #-}
393+-- #endif
394+-- HasReflexClient (Patch (ct ': cts) ()) where
395+-- type Input (Patch (ct ': cts) ()) = ()
396+-- type Client (Patch (ct ': cts) ()) = Final ()
397+-- clientWithRoute Proxy req baseurl _ =
398+-- void $ performRequestNoBody H.methodPatch req baseurl
399+--
400+-- -- | If you have a 'Patch xs (Headers ls x)' endpoint, the client expects the
401+-- -- corresponding headers.
402+-- instance
403+-- #if MIN_VERSION_base(4,8,0)
404+-- {-# OVERLAPPING #-}
405+-- #endif
406+-- ( MimeUnrender ct a, BuildHeadersTo ls
407+-- ) => HasReflexClient (Patch (ct ': cts) (Headers ls a)) where
408+-- type Input (Patch (ct ': cts) (Headers ls a)) = ()
409+-- type Client (Patch (ct ': cts) (Headers ls a)) = Final (Headers ls a)
410+-- clientWithRoute Proxy req baseurl _ = do
411+-- (hdrs, resp) <- performRequestCT (Proxy :: Proxy ct) H.methodPatch req baseurl
412+-- return $ Headers { getResponse = resp
413+-- , getHeadersHList = buildHeadersTo hdrs
414+-- }
415+--
416+-- -- | If you use a 'QueryParam' in one of your endpoints in your API,
417+-- -- the corresponding querying function will automatically take
418+-- -- an additional argument of the type specified by your 'QueryParam',
419+-- -- enclosed in Maybe.
420+-- --
421+-- -- If you give Nothing, nothing will be added to the query string.
422+-- --
423+-- -- If you give a non-'Nothing' value, this function will take care
424+-- -- of inserting a textual representation of this value in the query string.
425+-- --
426+-- -- You can control how values for your type are turned into
427+-- -- text by specifying a 'ToHttpApiData' instance for your type.
428+-- --
429+-- -- Example:
430+-- --
431+-- -- > type MyApi = "books" :> QueryParam "author" Text :> Get '[JSON] [Book]
432+-- -- >
433+-- -- > myApi :: Proxy MyApi
434+-- -- > myApi = Proxy
435+-- -- >
436+-- -- > getBooksBy :: Maybe Text -> ExceptT String IO [Book]
437+-- -- > getBooksBy = client myApi host
438+-- -- > where host = BaseUrl Http "localhost" 8080
439+-- -- > -- then you can just use "getBooksBy" to query that endpoint.
440+-- -- > -- 'getBooksBy Nothing' for all books
441+-- -- > -- 'getBooksBy (Just "Isaac Asimov")' to get all books by Isaac Asimov
442+-- instance (KnownSymbol sym, ToHttpApiData a, HasReflexClient sublayout)
443+-- => HasReflexClient (QueryParam sym a :> sublayout) where
444+--
445+-- type Input (QueryParam sym a :> sublayout) = Maybe a ::> Input sublayout
446+-- type Client (QueryParam sym a :> sublayout) = Client sublayout
447+--
448+-- -- if mparam = Nothing, we don't add it to the query string
449+-- clientWithRoute Proxy req baseurl (mparam ::> rest) =
450+-- clientWithRoute (Proxy :: Proxy sublayout)
451+-- (maybe req
452+-- (flip (appendToQueryString pname) req . Just)
453+-- mparamText
454+-- )
455+-- baseurl rest
456+--
457+-- where pname = cs pname'
458+-- pname' = symbolVal (Proxy :: Proxy sym)
459+-- mparamText = fmap toQueryParam mparam
460+--
461+-- -- | If you use a 'QueryParams' in one of your endpoints in your API,
462+-- -- the corresponding querying function will automatically take
463+-- -- an additional argument, a list of values of the type specified
464+-- -- by your 'QueryParams'.
465+-- --
466+-- -- If you give an empty list, nothing will be added to the query string.
467+-- --
468+-- -- Otherwise, this function will take care
469+-- -- of inserting a textual representation of your values in the query string,
470+-- -- under the same query string parameter name.
471+-- --
472+-- -- You can control how values for your type are turned into
473+-- -- text by specifying a 'ToHttpApiData' instance for your type.
474+-- --
475+-- -- Example:
476+-- --
477+-- -- > type MyApi = "books" :> QueryParams "authors" Text :> Get '[JSON] [Book]
478+-- -- >
479+-- -- > myApi :: Proxy MyApi
480+-- -- > myApi = Proxy
481+-- -- >
482+-- -- > getBooksBy :: [Text] -> ExceptT String IO [Book]
483+-- -- > getBooksBy = client myApi host
484+-- -- > where host = BaseUrl Http "localhost" 8080
485+-- -- > -- then you can just use "getBooksBy" to query that endpoint.
486+-- -- > -- 'getBooksBy []' for all books
487+-- -- > -- 'getBooksBy ["Isaac Asimov", "Robert A. Heinlein"]'
488+-- -- > -- to get all books by Asimov and Heinlein
489+-- instance (KnownSymbol sym, ToHttpApiData a, HasReflexClient sublayout)
490+-- => HasReflexClient (QueryParams sym a :> sublayout) where
491+--
492+-- type Input (QueryParams sym a :> sublayout) = [a] ::> Input sublayout
493+-- type Client (QueryParams sym a :> sublayout) = Client sublayout
494+--
495+-- clientWithRoute Proxy req baseurl (paramlist ::> rest) =
496+-- clientWithRoute (Proxy :: Proxy sublayout)
497+-- (foldl' (\ req' -> maybe req' (flip (appendToQueryString pname) req' . Just))
498+-- req
499+-- paramlist'
500+-- )
501+-- baseurl rest
502+--
503+-- where pname = cs pname'
504+-- pname' = symbolVal (Proxy :: Proxy sym)
505+-- paramlist' = map (Just . toQueryParam) paramlist
506+--
507+-- -- | If you use a 'QueryFlag' in one of your endpoints in your API,
508+-- -- the corresponding querying function will automatically take
509+-- -- an additional 'Bool' argument.
510+-- --
511+-- -- If you give 'False', nothing will be added to the query string.
512+-- --
513+-- -- Otherwise, this function will insert a value-less query string
514+-- -- parameter under the name associated to your 'QueryFlag'.
515+-- --
516+-- -- Example:
517+-- --
518+-- -- > type MyApi = "books" :> QueryFlag "published" :> Get '[JSON] [Book]
519+-- -- >
520+-- -- > myApi :: Proxy MyApi
521+-- -- > myApi = Proxy
522+-- -- >
523+-- -- > getBooks :: Bool -> ExceptT String IO [Book]
524+-- -- > getBooks = client myApi host
525+-- -- > where host = BaseUrl Http "localhost" 8080
526+-- -- > -- then you can just use "getBooks" to query that endpoint.
527+-- -- > -- 'getBooksBy False' for all books
528+-- -- > -- 'getBooksBy True' to only get _already published_ books
529+-- instance (KnownSymbol sym, HasReflexClient sublayout)
530+-- => HasReflexClient (QueryFlag sym :> sublayout) where
531+--
532+-- type Input (QueryFlag sym :> sublayout) = Bool ::> Input sublayout
533+-- type Client (QueryFlag sym :> sublayout) = Client sublayout
534+--
535+-- clientWithRoute Proxy req baseurl (flag ::> rest) =
536+-- clientWithRoute (Proxy :: Proxy sublayout)
537+-- (if flag
538+-- then appendToQueryString paramname Nothing req
539+-- else req
540+-- )
541+-- baseurl rest
542+--
543+-- where paramname = cs $ symbolVal (Proxy :: Proxy sym)
544+--
545+--
546+-- -- | If you use a 'ReqBody' in one of your endpoints in your API,
547+-- -- the corresponding querying function will automatically take
548+-- -- an additional argument of the type specified by your 'ReqBody'.
549+-- -- That function will take care of encoding this argument as JSON and
550+-- -- of using it as the request body.
551+-- --
552+-- -- All you need is for your type to have a 'ToJSON' instance.
553+-- --
554+-- -- Example:
555+-- --
556+-- -- > type MyApi = "books" :> ReqBody '[JSON] Book :> Post '[JSON] Book
557+-- -- >
558+-- -- > myApi :: Proxy MyApi
559+-- -- > myApi = Proxy
560+-- -- >
561+-- -- > addBook :: Book -> ExceptT String IO Book
562+-- -- > addBook = client myApi host
563+-- -- > where host = BaseUrl Http "localhost" 8080
564+-- -- > -- then you can just use "addBook" to query that endpoint
565+-- instance (MimeRender ct a, HasReflexClient sublayout)
566+-- => HasReflexClient (ReqBody (ct ': cts) a :> sublayout) where
567+--
568+-- type Input (ReqBody (ct ': cts) a :> sublayout) = a ::> Input sublayout
569+-- type Client (ReqBody (ct ': cts) a :> sublayout) = Client sublayout
570+--
571+-- clientWithRoute Proxy req baseurl (body ::> rest) =
572+-- clientWithRoute (Proxy :: Proxy sublayout)
573+-- (let ctProxy = Proxy :: Proxy ct
574+-- in setRQBody (mimeRender ctProxy body)
575+-- (contentType ctProxy)
576+-- req
577+-- )
578+-- baseurl rest
505579--
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−
533580-- | 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
581+instance (KnownSymbol path, HasReflexClient sublayout) => HasReflexClient (path :> sublayout) where
582+ type Input (path :> sublayout) = Input sublayout
583+ type Output (path :> sublayout) = Output sublayout
584+ clientWithRoute Proxy req baseurl val =
585+ clientWithRoute (Proxy :: Proxy sublayout)
586+ (appendToPath p req)
587+ baseurl val
540588
541589 where p = symbolVal (Proxy :: Proxy path)
542590
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.
591+-- instance HasReflexClient api => HasReflexClient (Vault :> api) where
592+-- type Input (Vault :> api) = Input api
593+-- type Client (Vault :> api) = Client api
605594--
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−
595+-- clientWithRoute Proxy req baseurl val =
596+-- clientWithRoute (Proxy :: Proxy api) req baseurl val
597+--
598+-- instance HasReflexClient api => HasReflexClient (RemoteHost :> api) where
599+-- type Input (RemoteHost :> api) = Input api
600+-- type Client (RemoteHost :> api) = Client api
601+--
602+-- clientWithRoute Proxy req baseurl val =
603+-- clientWithRoute (Proxy :: Proxy api) req baseurl val
604+--
605+-- instance HasReflexClient api => HasReflexClient (IsSecure :> api) where
606+-- type Input (IsSecure :> api) = Input api
607+-- type Client (IsSecure :> api) = Client api
608+--
609+-- clientWithRoute Proxy req baseurl val =
610+-- clientWithRoute (Proxy :: Proxy api) req baseurl val