@@ -1,624 +1,619 @@
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 TupleSections #-}
9+{-# LANGUAGE TypeFamilies #-}
10+{-# LANGUAGE TypeOperators #-}
11+{-# LANGUAGE UndecidableInstances #-}
12+{-# LANGUAGE RankNTypes #-}
13+#if !MIN_VERSION_base(4,8,0)
14+{-# LANGUAGE OverlappingInstances #-}
2015#endif
21−
22−-- #include "overlapping-compat.h"
2316-- | This module provides 'client' which can automatically generate
2417-- querying functions for each endpoint just from the type representing your
2518-- API.
2619module Servant.Reflex
27− ( 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
23+ , module Servant.Common.Req
3824 ) where
3925
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−
26+#if !MIN_VERSION_base(4,8,0)
27+import Control.Applicative ((<$>))
28+#endif
29+import Control.Monad.Trans (liftIO)
30+import Data.Default
31+import Data.Proxy
32+import Data.String.Conversions
33+import GHC.TypeLits
34+import Servant.API
35+import Servant.Common.BaseUrl
36+import Servant.Common.Req
37+import Reflex
38+import Reflex.Dom
39+--import Reflex.Dom.Xhr
9340
9441-- * Accessing APIs as a Client
9542
9643-- | 'client' allows you to produce operations to query an API from a client.
9744--
9845-- > type MyApi = "books" :> Get '[JSON] [Book] -- GET /books
99−-- > :<|> "books" :> ReqBody '[JSON] Book :> Post '[JSON] Book -- POST /books
46+-- > :<|> "books" :> ReqBody '[JSON] Book :> Post Book -- POST /books
10047-- >
10148-- > myApi :: Proxy MyApi
10249-- > myApi = Proxy
10350-- >
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)))
51+-- > getAllBooks :: ExceptT String IO [Book]
52+-- > postNewBook :: Book -> ExceptT String IO Book
10753-- > (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
54+-- > where host = BaseUrl Http "localhost" 8080
55+--client :: HasReflexClient layout
56+-- => Proxy layout
57+-- -> BaseUrl
58+-- -> Client (Input layout) (Output layout)
59+--client p baseurl = clientWithRoute p defReq baseurl
11760
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
61+data a ::> b = a ::> b deriving (Eq,Ord,Show,Read)
12762
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
63+infixr 3 ::>
14164
65+--type SingleClient ins outs = MonadWidget t m => Event t ins -> m (Event t (ins,outs))
66+--type SingleClient a = MonadWidget t m => Event t (Input a) -> m (Event t (Input a,Output a))
14267
14368-- | This class lets us define how each API combinator
14469-- influences the creation of an HTTP request. It's mostly
14570-- 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 :: *
71+class HasReflexClient layout where
72+ type Input layout :: *
73+ type Output layout :: *
14874 clientWithRoute
75+ :: MonadWidget t m
76+ => Proxy layout
77+ -> Req
78+ -> BaseUrl
79+ -> Event t (Input layout)
80+ -> m (Event t (Input layout, Output layout))
81+
82+class HasReflexClients layout where
83+ type Clients layout :: *
84+ clientsWithRoute
14985 :: 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
86+ -> Req
87+ -> BaseUrl
88+ -> Clients layout
89+
90+
91+-- | If you have a 'Get' endpoint in your API, the client
92+-- side querying function that is created when calling 'client'
93+-- will just require an argument that specifies the scheme, host
94+-- and port to send the request to.
95+instance
96+#if MIN_VERSION_base(4,8,0)
97+ {-# OVERLAPPABLE #-}
98+#endif
99+ (MimeUnrender ct result) => HasReflexClient (Get (ct ': cts) result) where
100+ type Input (Get (ct ': cts) result) = ()
101+ type Output (Get (ct ': cts) result) = result
102+ -- type Client (Get (ct ': cts) result) = MonadWidget t m => Event t (Input layout) -> m (Event t result)
103+ clientWithRoute Proxy req baseurl trigEvents =
104+ performAJAX requestBuilder responseParser trigEvents
105+ where
106+ requestBuilder _ = XhrRequest "GET" (showBaseUrl baseurl) def
107+ responseParser xhrResp =
108+ hush . mimeUnrender (Proxy :: Proxy ct) =<<
109+ (cs <$> _xhrResponse_responseText xhrResp)
110+
111+hush (Left _) = Nothing
112+hush (Right a) = Just a
113+
114+performAJAX
115+ :: (MonadWidget t m)
116+ => (a -> XhrRequest)
117+ -- ^ Function to build the request
118+ -> (XhrResponse -> Maybe b)
119+ -- ^ Function to parse the response
120+ -> Event t a
121+ -> m (Event t (a, b))
122+performAJAX mkRequest parseResponse req = do
123+ e <- performEventAsync $ ffor req $ \a cb -> do
124+ _ <- newXMLHttpRequest (mkRequest a) $ \response ->
125+ liftIO $ cb $ (a,) <$> parseResponse response
126+ return ()
127+ return $ fmapMaybe id e
128+
129+
130+instance
131+#if MIN_VERSION_base(4,8,0)
132+ {-# OVERLAPPING #-}
133+#endif
134+ HasReflexClient (Get (ct ': cts) ()) where
135+ type Input (Get (ct ': cts) ()) = ()
136+ type Output (Get (ct ': cts) ()) = ()
137+ -- type Client (Get (ct ': cts) ()) = MonadWidget t m => Event t () -> m (Event t ())
138+ clientWithRoute Proxy req baseurl trigEvents =
139+ performAJAX requestBuilder responseParser trigEvents
140+ where
141+ requestBuilder _ = XhrRequest "GET" (showBaseUrl baseurl) def
142+ responseParser _ = Just ()
143+
144+-- -- | Pick a 'Method' and specify where the server you want to query is. You get
145+-- -- back the full `Response`.
146+-- instance HasReflexClient Raw where
147+-- type Input Raw = H.Method ::> ()
148+-- type Client Raw = Final (Int, ByteString, MediaType, [HTTP.Header], Response ByteString)
149+
150+-- clientWithRoute :: Proxy Raw -> Req -> BaseUrl -> Input Raw -> Client Raw
151+-- clientWithRoute Proxy req baseurl (httpMethod ::> ()) = do
152+-- performRequest httpMethod req baseurl
153+
154+-- -- | If you have a 'Get xs (Headers ls x)' endpoint, the client expects the
155+-- -- corresponding headers.
156+-- instance
157+-- #if MIN_VERSION_base(4,8,0)
158+-- {-# OVERLAPPING #-}
159+-- #endif
160+-- ( MimeUnrender ct a, BuildHeadersTo ls
161+-- ) => HasReflexClient (Get (ct ': cts) (Headers ls a)) where
162+-- type Input (Get (ct ': cts) (Headers ls a)) = ()
163+-- type Client (Get (ct ': cts) (Headers ls a)) = Final (Headers ls a)
164+-- clientWithRoute Proxy req baseurl _ = do
165+-- (hdrs, resp) <- performRequestCT (Proxy :: Proxy ct) H.methodGet req baseurl
166+-- return $ Headers { getResponse = resp
167+-- , getHeadersHList = buildHeadersTo hdrs
168+-- }
169+
170+-- | A client querying function for @a ':<|>' b@ will actually hand you
171+-- one function for querying @a@ and another one for querying @b@,
172+-- stitching them together with ':<|>', which really is just like a pair.
173+--
174+-- > type MyApi = "books" :> Get '[JSON] [Book] -- GET /books
175+-- > :<|> "books" :> ReqBody '[JSON] Book :> Post Book -- POST /books
297176-- >
177+-- > myApi :: Proxy MyApi
178+-- > myApi = Proxy
298179-- >
299−-- > viewReferer :: Maybe Referer -> ExceptT String IO Book
300−-- > viewReferer = client myApi host
180+-- > getAllBooks :: ExceptT String IO [Book]
181+-- > postNewBook :: Book -> ExceptT String IO Book
182+-- > (getAllBooks :<|> postNewBook) = client myApi host
301183-- > 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.
184+--instance (HasReflexClient a, HasReflexClient b) => HasReflexClients (a :<|> b) where
185+-- type Clients (a :<|> b) = SingleClient a :<|> SingleClient b
186+-- clientsWithRoute Proxy req baseurl (a :<|> b) =
187+-- clientWithRoute (Proxy :: Proxy a) req baseurl :<|>
188+-- clientWithRoute (Proxy :: Proxy b) req baseurl
189+
190+-- ------------------------------------------------------------------------------
191+-- -- | If you use a 'Capture' in one of your endpoints in your API,
192+-- -- the corresponding querying function will automatically take
193+-- -- an additional argument of the type specified by your 'Capture'.
194+-- -- That function will take care of inserting a textual representation
195+-- -- of this value at the right place in the request path.
196+-- --
197+-- -- You can control how values for this type are turned into
198+-- -- text by specifying a 'ToHttpApiData' instance for your type.
199+-- --
200+-- -- Example:
201+-- --
202+-- -- > type MyApi = "books" :> Capture "isbn" Text :> Get '[JSON] Book
203+-- -- >
204+-- -- > myApi :: Proxy MyApi
205+-- -- > myApi = Proxy
206+-- -- >
207+-- -- > getBook :: Text -> ExceptT String IO Book
208+-- -- > getBook = client myApi host
209+-- -- > where host = BaseUrl Http "localhost" 8080
210+-- -- > -- then you can just use "getBook" to query that endpoint
211+-- instance (KnownSymbol capture, ToHttpApiData a, HasReflexClient sublayout)
212+-- => HasReflexClient (Capture capture a :> sublayout) where
350213--
351−-- If you give Nothing, nothing will be added to the query string.
214+-- type Input (Capture cap a :> sublayout) = a ::> Input sublayout
215+-- type Client (Capture capture a :> sublayout) = Client sublayout
352216--
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.
217+-- clientWithRoute Proxy req baseurl (val ::> rest) =
218+-- clientWithRoute (Proxy :: Proxy sublayout)
219+-- (appendToPath p req) baseurl rest
355220--
356−-- You can control how values for your type are turned into
357−-- text by specifying a 'ToHttpApiData' instance for your type.
221+-- where p = unpack (toUrlPiece val)
358222--
359−-- Example:
223+-- -- | If you have a 'Delete' endpoint in your API, the client
224+-- -- side querying function that is created when calling 'client'
225+-- -- will just require an argument that specifies the scheme, host
226+-- -- and port to send the request to.
227+-- instance
228+-- #if MIN_VERSION_base(4,8,0)
229+-- {-# OVERLAPPABLE #-}
230+-- #endif
231+-- (MimeUnrender ct a, cts' ~ (ct ': cts)) => HasReflexClient (Delete cts' a) where
232+-- type Input (Delete cts' a) = ()
233+-- type Client (Delete cts' a) = Final a
234+-- clientWithRoute Proxy req baseurl val =
235+-- snd <$> performRequestCT (Proxy :: Proxy ct) H.methodDelete req baseurl val
360236--
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' mods sym a :> sublayout) tag where
374−
375− type Client t m (QueryParam' mods 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'.
237+-- instance
238+-- #if MIN_VERSION_base(4,8,0)
239+-- {-# OVERLAPPING #-}
240+-- #endif
241+-- HasReflexClient (Delete cts ()) where
242+-- type Input (Delete cts ()) = ()
243+-- type Client (Delete cts ()) = Final ()
244+-- clientWithRoute Proxy req baseurl val =
245+-- void $ performRequestNoBody H.methodDelete req baseurl val
395246--
396−-- If you give an empty list, nothing will be added to the query string.
247+-- -- | If you have a 'Delete xs (Headers ls x)' endpoint, the client expects the
248+-- -- corresponding headers.
249+-- instance
250+-- #if MIN_VERSION_base(4,8,0)
251+-- {-# OVERLAPPING #-}
252+-- #endif
253+-- ( MimeUnrender ct a, BuildHeadersTo ls, cts' ~ (ct ': cts)
254+-- ) => HasReflexClient (Delete cts' (Headers ls a)) where
255+-- type Input (Delete cts' (Headers ls a)) = ()
256+-- type Client (Delete cts' (Headers ls a)) = Final (Headers ls a)
257+-- clientWithRoute Proxy req baseurl _ = do
258+-- (hdrs, resp) <- performRequestCT (Proxy :: Proxy ct) H.methodDelete req baseurl
259+-- return $ Headers { getResponse = resp
260+-- , getHeadersHList = buildHeadersTo hdrs
261+-- }
397262--
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.
263+-- -- | If you use a 'Header' in one of your endpoints in your API,
264+-- -- the corresponding querying function will automatically take
265+-- -- an additional argument of the type specified by your 'Header',
266+-- -- wrapped in Maybe.
267+-- --
268+-- -- That function will take care of encoding this argument as Text
269+-- -- in the request headers.
270+-- --
271+-- -- All you need is for your type to have a 'ToHttpApiData' instance.
272+-- --
273+-- -- Example:
274+-- --
275+-- -- > newtype Referer = Referer { referrer :: Text }
276+-- -- > deriving (Eq, Show, Generic, FromText, ToHttpApiData)
277+-- -- >
278+-- -- > -- GET /view-my-referer
279+-- -- > type MyApi = "view-my-referer" :> Header "Referer" Referer :> Get '[JSON] Referer
280+-- -- >
281+-- -- > myApi :: Proxy MyApi
282+-- -- > myApi = Proxy
283+-- -- >
284+-- -- > viewReferer :: Maybe Referer -> ExceptT String IO Book
285+-- -- > viewReferer = client myApi host
286+-- -- > where host = BaseUrl Http "localhost" 8080
287+-- -- > -- then you can just use "viewRefer" to query that endpoint
288+-- -- > -- specifying Nothing or e.g Just "http://haskell.org/" as arguments
289+-- instance (KnownSymbol sym, ToHttpApiData a, HasReflexClient sublayout)
290+-- => HasReflexClient (Header sym a :> sublayout) where
401291--
402−-- You can control how values for your type are turned into
403−-- text by specifying a 'ToHttpApiData' instance for your type.
292+-- type Input (Header sym a :> sublayout) = Maybe a ::> Input sublayout
293+-- type Client (Header sym a :> sublayout) = Client sublayout
404294--
405−-- Example:
295+-- clientWithRoute Proxy req baseurl (mval ::> rest) =
296+-- clientWithRoute (Proxy :: Proxy sublayout)
297+-- (maybe req
298+-- (\value -> Servant.Common.Req.addHeader hname value req)
299+-- mval
300+-- )
301+-- baseurl rest
406302--
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.
303+-- where hname = symbolVal (Proxy :: Proxy sym)
438304--
439−-- If you give 'False', nothing will be added to the query string.
305+-- -- | If you have a 'Post' endpoint in your API, the client
306+-- -- side querying function that is created when calling 'client'
307+-- -- will just require an argument that specifies the scheme, host
308+-- -- and port to send the request to.
309+-- instance
310+-- #if MIN_VERSION_base(4,8,0)
311+-- {-# OVERLAPPABLE #-}
312+-- #endif
313+-- (MimeUnrender ct a) => HasReflexClient (Post (ct ': cts) a) where
314+-- type Input (Post (ct ': cts) a) = ()
315+-- type Client (Post (ct ': cts) a) = Final a
316+-- clientWithRoute Proxy req baseurl _ =
317+-- snd <$> performRequestCT (Proxy :: Proxy ct) H.methodPost req baseurl
440318--
441−-- Otherwise, this function will insert a value-less query string
442−-- parameter under the name associated to your 'QueryFlag'.
319+-- instance
320+-- #if MIN_VERSION_base(4,8,0)
321+-- {-# OVERLAPPING #-}
322+-- #endif
323+-- HasReflexClient (Post (ct ': cts) ()) where
324+-- type Input (Post (ct ': cts) ()) = ()
325+-- type Client (Post (ct ': cts) ()) = Final ()
326+-- clientWithRoute Proxy req baseurl _ =
327+-- void $ performRequestNoBody H.methodPost req baseurl
443328--
444−-- Example:
329+-- -- | If you have a 'Post xs (Headers ls x)' endpoint, the client expects the
330+-- -- corresponding headers.
331+-- instance
332+-- #if MIN_VERSION_base(4,8,0)
333+-- {-# OVERLAPPING #-}
334+-- #endif
335+-- ( MimeUnrender ct a, BuildHeadersTo ls
336+-- ) => HasReflexClient (Post (ct ': cts) (Headers ls a)) where
337+-- type Input (Post (ct ': cts) (Headers ls a)) = ()
338+-- type Client (Post (ct ': cts) (Headers ls a)) = Final (Headers ls a)
339+-- clientWithRoute Proxy req baseurl _ = do
340+-- (hdrs, resp) <- performRequestCT (Proxy :: Proxy ct) H.methodPost req baseurl
341+-- return $ Headers { getResponse = resp
342+-- , getHeadersHList = buildHeadersTo hdrs
343+-- }
445344--
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.
345+-- -- | If you have a 'Put' endpoint in your API, the client
346+-- -- side querying function that is created when calling 'client'
347+-- -- will just require an argument that specifies the scheme, host
348+-- -- and port to send the request to.
349+-- instance
350+-- #if MIN_VERSION_base(4,8,0)
351+-- {-# OVERLAPPABLE #-}
352+-- #endif
353+-- (MimeUnrender ct a) => HasReflexClient (Put (ct ': cts) a) where
354+-- type Input (Put (ct ': cts) a) = ()
355+-- type Client (Put (ct ': cts) a) = Final a
356+-- clientWithRoute Proxy req baseurl _ =
357+-- snd <$> performRequestCT (Proxy :: Proxy ct) H.methodPut req baseurl
501358--
502−-- All you need is for your type to have a 'ToJSON' instance.
359+-- instance
360+-- #if MIN_VERSION_base(4,8,0)
361+-- {-# OVERLAPPING #-}
362+-- #endif
363+-- HasReflexClient (Put (ct ': cts) ()) where
364+-- type Input (Put (ct ': cts) ()) = ()
365+-- type Client (Put (ct ': cts) ()) = Final ()
366+-- clientWithRoute Proxy req baseurl _ =
367+-- void $ performRequestNoBody H.methodPut req baseurl
503368--
504−-- Example:
369+-- -- | If you have a 'Put xs (Headers ls x)' endpoint, the client expects the
370+-- -- corresponding headers.
371+-- instance
372+-- #if MIN_VERSION_base(4,8,0)
373+-- {-# OVERLAPPING #-}
374+-- #endif
375+-- ( MimeUnrender ct a, BuildHeadersTo ls
376+-- ) => HasReflexClient (Put (ct ': cts) (Headers ls a)) where
377+-- type Input (Put (ct ': cts) (Headers ls a)) = ()
378+-- type Client (Put (ct ': cts) (Headers ls a)) = Final (Headers ls a)
379+-- clientWithRoute Proxy req baseurl _ = do
380+-- (hdrs, resp) <- performRequestCT (Proxy :: Proxy ct) H.methodPut req baseurl
381+-- return $ Headers { getResponse = resp
382+-- , getHeadersHList = buildHeadersTo hdrs
383+-- }
384+--
385+-- -- | If you have a 'Patch' endpoint in your API, the client
386+-- -- side querying function that is created when calling 'client'
387+-- -- will just require an argument that specifies the scheme, host
388+-- -- and port to send the request to.
389+-- instance
390+-- #if MIN_VERSION_base(4,8,0)
391+-- {-# OVERLAPPABLE #-}
392+-- #endif
393+-- (MimeUnrender ct a) => HasReflexClient (Patch (ct ': cts) a) where
394+-- type Input (Patch (ct ': cts) a) = ()
395+-- type Client (Patch (ct ': cts) a) = Final a
396+-- clientWithRoute Proxy req baseurl _ =
397+-- snd <$> performRequestCT (Proxy :: Proxy ct) H.methodPatch req baseurl
398+--
399+-- instance
400+-- #if MIN_VERSION_base(4,8,0)
401+-- {-# OVERLAPPING #-}
402+-- #endif
403+-- HasReflexClient (Patch (ct ': cts) ()) where
404+-- type Input (Patch (ct ': cts) ()) = ()
405+-- type Client (Patch (ct ': cts) ()) = Final ()
406+-- clientWithRoute Proxy req baseurl _ =
407+-- void $ performRequestNoBody H.methodPatch req baseurl
408+--
409+-- -- | If you have a 'Patch xs (Headers ls x)' endpoint, the client expects the
410+-- -- corresponding headers.
411+-- instance
412+-- #if MIN_VERSION_base(4,8,0)
413+-- {-# OVERLAPPING #-}
414+-- #endif
415+-- ( MimeUnrender ct a, BuildHeadersTo ls
416+-- ) => HasReflexClient (Patch (ct ': cts) (Headers ls a)) where
417+-- type Input (Patch (ct ': cts) (Headers ls a)) = ()
418+-- type Client (Patch (ct ': cts) (Headers ls a)) = Final (Headers ls a)
419+-- clientWithRoute Proxy req baseurl _ = do
420+-- (hdrs, resp) <- performRequestCT (Proxy :: Proxy ct) H.methodPatch req baseurl
421+-- return $ Headers { getResponse = resp
422+-- , getHeadersHList = buildHeadersTo hdrs
423+-- }
424+--
425+-- -- | If you use a 'QueryParam' in one of your endpoints in your API,
426+-- -- the corresponding querying function will automatically take
427+-- -- an additional argument of the type specified by your 'QueryParam',
428+-- -- enclosed in Maybe.
429+-- --
430+-- -- If you give Nothing, nothing will be added to the query string.
431+-- --
432+-- -- If you give a non-'Nothing' value, this function will take care
433+-- -- of inserting a textual representation of this value in the query string.
434+-- --
435+-- -- You can control how values for your type are turned into
436+-- -- text by specifying a 'ToHttpApiData' instance for your type.
437+-- --
438+-- -- Example:
439+-- --
440+-- -- > type MyApi = "books" :> QueryParam "author" Text :> Get '[JSON] [Book]
441+-- -- >
442+-- -- > myApi :: Proxy MyApi
443+-- -- > myApi = Proxy
444+-- -- >
445+-- -- > getBooksBy :: Maybe Text -> ExceptT String IO [Book]
446+-- -- > getBooksBy = client myApi host
447+-- -- > where host = BaseUrl Http "localhost" 8080
448+-- -- > -- then you can just use "getBooksBy" to query that endpoint.
449+-- -- > -- 'getBooksBy Nothing' for all books
450+-- -- > -- 'getBooksBy (Just "Isaac Asimov")' to get all books by Isaac Asimov
451+-- instance (KnownSymbol sym, ToHttpApiData a, HasReflexClient sublayout)
452+-- => HasReflexClient (QueryParam sym a :> sublayout) where
453+--
454+-- type Input (QueryParam sym a :> sublayout) = Maybe a ::> Input sublayout
455+-- type Client (QueryParam sym a :> sublayout) = Client sublayout
456+--
457+-- -- if mparam = Nothing, we don't add it to the query string
458+-- clientWithRoute Proxy req baseurl (mparam ::> rest) =
459+-- clientWithRoute (Proxy :: Proxy sublayout)
460+-- (maybe req
461+-- (flip (appendToQueryString pname) req . Just)
462+-- mparamText
463+-- )
464+-- baseurl rest
465+--
466+-- where pname = cs pname'
467+-- pname' = symbolVal (Proxy :: Proxy sym)
468+-- mparamText = fmap toQueryParam mparam
469+--
470+-- -- | If you use a 'QueryParams' in one of your endpoints in your API,
471+-- -- the corresponding querying function will automatically take
472+-- -- an additional argument, a list of values of the type specified
473+-- -- by your 'QueryParams'.
474+-- --
475+-- -- If you give an empty list, nothing will be added to the query string.
476+-- --
477+-- -- Otherwise, this function will take care
478+-- -- of inserting a textual representation of your values in the query string,
479+-- -- under the same query string parameter name.
480+-- --
481+-- -- You can control how values for your type are turned into
482+-- -- text by specifying a 'ToHttpApiData' instance for your type.
483+-- --
484+-- -- Example:
485+-- --
486+-- -- > type MyApi = "books" :> QueryParams "authors" Text :> Get '[JSON] [Book]
487+-- -- >
488+-- -- > myApi :: Proxy MyApi
489+-- -- > myApi = Proxy
490+-- -- >
491+-- -- > getBooksBy :: [Text] -> ExceptT String IO [Book]
492+-- -- > getBooksBy = client myApi host
493+-- -- > where host = BaseUrl Http "localhost" 8080
494+-- -- > -- then you can just use "getBooksBy" to query that endpoint.
495+-- -- > -- 'getBooksBy []' for all books
496+-- -- > -- 'getBooksBy ["Isaac Asimov", "Robert A. Heinlein"]'
497+-- -- > -- to get all books by Asimov and Heinlein
498+-- instance (KnownSymbol sym, ToHttpApiData a, HasReflexClient sublayout)
499+-- => HasReflexClient (QueryParams sym a :> sublayout) where
500+--
501+-- type Input (QueryParams sym a :> sublayout) = [a] ::> Input sublayout
502+-- type Client (QueryParams sym a :> sublayout) = Client sublayout
503+--
504+-- clientWithRoute Proxy req baseurl (paramlist ::> rest) =
505+-- clientWithRoute (Proxy :: Proxy sublayout)
506+-- (foldl' (\ req' -> maybe req' (flip (appendToQueryString pname) req' . Just))
507+-- req
508+-- paramlist'
509+-- )
510+-- baseurl rest
511+--
512+-- where pname = cs pname'
513+-- pname' = symbolVal (Proxy :: Proxy sym)
514+-- paramlist' = map (Just . toQueryParam) paramlist
515+--
516+-- -- | If you use a 'QueryFlag' in one of your endpoints in your API,
517+-- -- the corresponding querying function will automatically take
518+-- -- an additional 'Bool' argument.
519+-- --
520+-- -- If you give 'False', nothing will be added to the query string.
521+-- --
522+-- -- Otherwise, this function will insert a value-less query string
523+-- -- parameter under the name associated to your 'QueryFlag'.
524+-- --
525+-- -- Example:
526+-- --
527+-- -- > type MyApi = "books" :> QueryFlag "published" :> Get '[JSON] [Book]
528+-- -- >
529+-- -- > myApi :: Proxy MyApi
530+-- -- > myApi = Proxy
531+-- -- >
532+-- -- > getBooks :: Bool -> ExceptT String IO [Book]
533+-- -- > getBooks = client myApi host
534+-- -- > where host = BaseUrl Http "localhost" 8080
535+-- -- > -- then you can just use "getBooks" to query that endpoint.
536+-- -- > -- 'getBooksBy False' for all books
537+-- -- > -- 'getBooksBy True' to only get _already published_ books
538+-- instance (KnownSymbol sym, HasReflexClient sublayout)
539+-- => HasReflexClient (QueryFlag sym :> sublayout) where
540+--
541+-- type Input (QueryFlag sym :> sublayout) = Bool ::> Input sublayout
542+-- type Client (QueryFlag sym :> sublayout) = Client sublayout
543+--
544+-- clientWithRoute Proxy req baseurl (flag ::> rest) =
545+-- clientWithRoute (Proxy :: Proxy sublayout)
546+-- (if flag
547+-- then appendToQueryString paramname Nothing req
548+-- else req
549+-- )
550+-- baseurl rest
551+--
552+-- where paramname = cs $ symbolVal (Proxy :: Proxy sym)
553+--
554+--
555+-- -- | If you use a 'ReqBody' in one of your endpoints in your API,
556+-- -- the corresponding querying function will automatically take
557+-- -- an additional argument of the type specified by your 'ReqBody'.
558+-- -- That function will take care of encoding this argument as JSON and
559+-- -- of using it as the request body.
560+-- --
561+-- -- All you need is for your type to have a 'ToJSON' instance.
562+-- --
563+-- -- Example:
564+-- --
565+-- -- > type MyApi = "books" :> ReqBody '[JSON] Book :> Post '[JSON] Book
566+-- -- >
567+-- -- > myApi :: Proxy MyApi
568+-- -- > myApi = Proxy
569+-- -- >
570+-- -- > addBook :: Book -> ExceptT String IO Book
571+-- -- > addBook = client myApi host
572+-- -- > where host = BaseUrl Http "localhost" 8080
573+-- -- > -- then you can just use "addBook" to query that endpoint
574+-- instance (MimeRender ct a, HasReflexClient sublayout)
575+-- => HasReflexClient (ReqBody (ct ': cts) a :> sublayout) where
576+--
577+-- type Input (ReqBody (ct ': cts) a :> sublayout) = a ::> Input sublayout
578+-- type Client (ReqBody (ct ': cts) a :> sublayout) = Client sublayout
579+--
580+-- clientWithRoute Proxy req baseurl (body ::> rest) =
581+-- clientWithRoute (Proxy :: Proxy sublayout)
582+-- (let ctProxy = Proxy :: Proxy ct
583+-- in setRQBody (mimeRender ctProxy body)
584+-- (contentType ctProxy)
585+-- req
586+-- )
587+-- baseurl rest
505588--
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−
533589-- | 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
590+instance (KnownSymbol path, HasReflexClient sublayout) => HasReflexClient (path :> sublayout) where
591+ type Input (path :> sublayout) = Input sublayout
592+ type Output (path :> sublayout) = Output sublayout
593+ clientWithRoute Proxy req baseurl val =
594+ clientWithRoute (Proxy :: Proxy sublayout)
595+ (appendToPath p req)
596+ baseurl val
540597
541598 where p = symbolVal (Proxy :: Proxy path)
542599
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.
600+-- instance HasReflexClient api => HasReflexClient (Vault :> api) where
601+-- type Input (Vault :> api) = Input api
602+-- type Client (Vault :> api) = Client api
605603--
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
604+-- clientWithRoute Proxy req baseurl val =
605+-- clientWithRoute (Proxy :: Proxy api) req baseurl val
606+--
607+-- instance HasReflexClient api => HasReflexClient (RemoteHost :> api) where
608+-- type Input (RemoteHost :> api) = Input api
609+-- type Client (RemoteHost :> api) = Client api
610+--
611+-- clientWithRoute Proxy req baseurl val =
612+-- clientWithRoute (Proxy :: Proxy api) req baseurl val
613+--
614+-- instance HasReflexClient api => HasReflexClient (IsSecure :> api) where
615+-- type Input (IsSecure :> api) = Input api
616+-- type Client (IsSecure :> api) = Client api
617+--
618+-- clientWithRoute Proxy req baseurl val =
619+-- clientWithRoute (Proxy :: Proxy api) req baseurl val