@@ -1,593 +1,625 @@
1−{-# LANGUAGE CPP #-}
1+{-# LANGUAGE AllowAmbiguousTypes #-}
2−{-# LANGUAGE DataKinds #-}
2+{-# LANGUAGE CPP #-}
3−{-# LANGUAGE FlexibleContexts #-}
3+{-# LANGUAGE DataKinds #-}
4−{-# LANGUAGE FlexibleInstances #-}
4+{-# LANGUAGE FlexibleContexts #-}
5−{-# LANGUAGE InstanceSigs #-}
5+{-# LANGUAGE FlexibleInstances #-}
6−{-# LANGUAGE OverloadedStrings #-}
6+{-# LANGUAGE GeneralizedNewtypeDeriving #-}
7−{-# LANGUAGE ScopedTypeVariables #-}
7+{-# LANGUAGE InstanceSigs #-}
8−{-# LANGUAGE TypeFamilies #-}
8+{-# LANGUAGE MultiParamTypeClasses #-}
9−{-# LANGUAGE TypeOperators #-}
9+{-# LANGUAGE OverloadedStrings #-}
10−{-# LANGUAGE UndecidableInstances #-}
10+{-# LANGUAGE PolyKinds #-}
11−{-# LANGUAGE RankNTypes #-}
11+{-# LANGUAGE Rank2Types #-}
12−#if !MIN_VERSION_base(4,8,0)
12+{-# LANGUAGE ScopedTypeVariables #-}
13−{-# LANGUAGE OverlappingInstances #-}
13+{-# LANGUAGE TupleSections #-}
14+{-# LANGUAGE TypeFamilies #-}
15+{-# LANGUAGE TypeOperators #-}
16+{-# LANGUAGE UndecidableInstances #-}
18+#if MIN_VERSION_base(4,9,0)
19+{-# OPTIONS_GHC -fno-warn-redundant-constraints #-}
22+-- #include "overlapping-compat.h"
15-- | This module provides 'client' which can automatically generate
23-- | This module provides 'client' which can automatically generate
16-- querying functions for each endpoint just from the type representing your
24-- querying functions for each endpoint just from the type representing your
18module Servant.Reflex
26module Servant.Reflex
20− , HasReflexClient(..)
28+ , clientWithOpts
21− , ServantError(..)
29+ , clientWithOptsAndResultHandler
31+ , clientWithRouteAndResultHandler
32+ , BuildHeaderKeysTo(..)
36+ , module Servant.Common.Req
22 , module Servant.Common.BaseUrl
37 , module Servant.Common.BaseUrl
25−#if !MIN_VERSION_base(4,8,0)
40+------------------------------------------------------------------------------
26−import Control.Applicative ((<$>))
41+import Control.Applicative
27−#endif
42+import qualified Data.CaseInsensitive as CI
28−import Control.Monad
43+import Data.Functor.Identity
29−import Control.Monad.Trans.Except
44+import qualified Data.Map as Map
30−import Data.ByteString.Lazy (ByteString)
45+import Data.Monoid ((<>))
31−import Data.Default
46+import Data.Proxy (Proxy (..))
32−import Data.List
47+import qualified Data.Set as Set
33−import Data.Proxy
48+import Data.Text (Text)
34−import Data.String.Conversions
49+import qualified Data.Text as T
35−import Data.Text (unpack)
50+import qualified Data.Text.Encoding as E
36−import GHC.TypeLits
51+import GHC.Exts (Constraint)
37−import Network.HTTP.Media
52+import GHC.TypeLits (KnownSymbol, symbolVal)
38−import qualified Network.HTTP.Types as H
53+import Servant.API ((:<|>) (..), (:>), BasicAuth,
39−import qualified Network.HTTP.Types.Header as HTTP
54+ BasicAuthData, BuildHeadersTo (..),
40−import Servant.API
55+ Capture, Header, Headers (..),
41−import Servant.Common.BaseUrl
56+ HttpVersion, IsSecure,
42−import Servant.Common.Req
57+ MimeRender (..), MimeUnrender,
43−import Reflex
58+ NoContent, QueryFlag, QueryParam,
44−import Reflex.Dom
59+ QueryParams, Raw, ReflectMethod (..),
45−import Web.HttpApiData
60+ RemoteHost, ReqBody,
46−import Reflex.Dom.Contrib.Xhr
61+ ToHttpApiData (..), Vault, Verb,
47−import Reflex.Dom.Xhr
62+ contentType)
63+import Servant.API.Description (Summary)
64+import qualified Servant.Auth as Auth
66+import Reflex.Dom.Core (Dynamic, Event, Reflex,
67+ XhrRequest (..), XhrResponse (..),
68+ XhrResponseHeaders (..),
69+ attachPromptlyDynWith, constDyn, ffor,
71+ performRequestsAsync)
72+------------------------------------------------------------------------------
73+import Servant.Common.BaseUrl (BaseUrl(..), Scheme(..), baseUrlWidget,
75+ SupportsServantReflex)
76+import Servant.Common.Req (ClientOptions(..),
77+ defaultClientOptions,
78+ Req, ReqResult(..), QParam(..),
79+ QueryPart(..), addHeader, authData,
80+ defReq, evalResponse, prependToPathParts,
83+ -- performRequestNoBody,
84+ performRequestsNoBody,
85+ performSomeRequestsAsync,
86+ qParamToQueryPart, reqBody,
87+ reqSuccess, reqFailure,
88+ reqMethod, respHeaders,
91+ qParams, withCredentials)
49-- * Accessing APIs as a Client
94-- * Accessing APIs as a Client
51-- | 'client' allows you to produce operations to query an API from a client.
96-- | 'client' allows you to produce operations to query an API from a client.
53-- > type MyApi = "books" :> Get '[JSON] [Book] -- GET /books
98-- > type MyApi = "books" :> Get '[JSON] [Book] -- GET /books
54−-- > :<|> "books" :> ReqBody '[JSON] Book :> Post Book -- POST /books
99+-- > :<|> "books" :> ReqBody '[JSON] Book :> Post '[JSON] Book -- POST /books
56-- > myApi :: Proxy MyApi
101-- > myApi :: Proxy MyApi
57-- > myApi = Proxy
102-- > myApi = Proxy
59−-- > getAllBooks :: ExceptT String IO [Book]
104+-- > getAllBooks :: Event t l -> m (Event t (l, ReqResult [Book]))
60−-- > postNewBook :: Book -> ExceptT String IO Book
105+-- > postNewBook :: Dynamic t (Maybe Book) -> Event t l
106+-- > -> m (Event t (l, ReqResult Book)))
61-- > (getAllBooks :<|> postNewBook) = client myApi host
107-- > (getAllBooks :<|> postNewBook) = client myApi host
62−-- > where host = BaseUrl Http "localhost" 8080
108+-- > where host = constDyn $ BaseUrl Http "localhost" 8080
63−client :: HasReflexClient layout
109+client
64− => Proxy layout
110+ :: (HasClient t m layout tag)
65− -> BaseUrl
111+ => Proxy layout
66− -- -> Input layout
112+ -> Proxy m
67− -> Client (Input layout) (Output layout)
113+ -> Proxy tag
68−client p baseurl = clientWithRoute p defReq baseurl
114+ -> Dynamic t BaseUrl
115+ -> Client t m layout tag
116+client p q t baseurl = clientWithRoute p q t defReq baseurl defaultClientOptions
70−data a ::> b = a ::> b deriving (Eq,Ord,Show,Read)
118+clientWithOpts
119+ :: (HasClient t m layout tag)
123+ -> Dynamic t BaseUrl
125+ -> Client t m layout tag
126+clientWithOpts p q t baseurl = clientWithRoute p q t defReq baseurl
72−infixr 3 ::>
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)
136+ -> Dynamic t BaseUrl
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
75−type Client ins outs = MonadWidget t m => Event t ins -> m (Event t (ins,outs))
77-- | This class lets us define how each API combinator
143-- | This class lets us define how each API combinator
78-- influences the creation of an HTTP request. It's mostly
144-- influences the creation of an HTTP request. It's mostly
79-- an internal class, you can just use 'client'.
145-- an internal class, you can just use 'client'.
80−class HasReflexClient layout where
146+class Monad m => HasClient t m layout (tag :: *) where
81− type Input layout :: *
147+ type Client t m layout tag :: *
82− type Output layout :: *
148+ clientWithRoute
83− clientWithRoute :: Proxy layout -> Req -> BaseUrl -- -> Input layout
149+ :: Proxy layout
84− -> Client (Input layout) (Output layout)
150+ -> Proxy m
87−-- -- | If you have a 'Get' endpoint in your API, the client
153+ -> Dynamic t BaseUrl
88−-- -- side querying function that is created when calling 'client'
154+ -> ClientOptions
89−-- -- will just require an argument that specifies the scheme, host
155+ -> Client t m layout tag
90−-- -- and port to send the request to.
156+ clientWithRoute l m t r b o = clientWithRouteAndResultHandler l m t r b o return
92−-- #if MIN_VERSION_base(4,8,0)
158+ clientWithRouteAndResultHandler
93−-- {-# OVERLAPPABLE #-}
159+ :: Proxy layout
94−-- #endif
160+ -> Proxy m
95−-- (MimeUnrender ct result) => HasReflexClient (Get (ct ': cts) result) where
161+ -> Proxy tag
96−-- type Input (Get (ct ': cts) result) = ()
162+ -> Req t
97−-- -- type Output (Get (ct' : cts) result) = result
163+ -> Dynamic t BaseUrl
98−-- type Client (Get (ct ': cts) result) = Final result
164+ -> ClientOptions
99−-- clientWithRoute Proxy req baseurl _ =
165+ -> (forall a. Event t (ReqResult tag a) -> m (Event t (ReqResult tag a)))
100−-- snd <$> performRequestCT (Proxy :: Proxy ct) H.methodGet req baseurl
166+ -> Client t m layout tag
103−#if MIN_VERSION_base(4,8,0)
169+instance (HasClient t m a tag, HasClient t m b tag) => HasClient t m (a :<|> b) tag where
104− {-# OVERLAPPING #-}
170+ type Client t m (a :<|> b) tag = Client t m a tag :<|> Client t m b tag
106− HasReflexClient (Get (ct ': cts) ()) where
172+ clientWithRouteAndResultHandler Proxy q pTag req baseurl opts wrap =
107− type Input (Get (ct ': cts) ()) = ()
173+ clientWithRouteAndResultHandler (Proxy :: Proxy a) q pTag req baseurl opts wrap :<|>
108− type Output (Get (ct ': cts) ()) = ()
174+ clientWithRouteAndResultHandler (Proxy :: Proxy b) q pTag req baseurl opts wrap
109− -- type Client (Get (ct ': cts) ()) = Final ()
175+
110− clientWithRoute Proxy req baseurl trigEvents =
176+
111− performAJAX requestBuilder responseParser trigEvents
177+-- Capture. Example:
112− where
178+-- > type MyApi = "books" :> Capture "isbn" Text :> Get '[JSON] Book
113− requestBuilder _ = XhrRequest "GET" (showBaseUrl baseurl) def
179+-- >
114− responseParser _ = ()
180+-- > myApi :: Proxy MyApi = Proxy
116−-- -- | Pick a 'Method' and specify where the server you want to query is. You get
182+-- > getBook :: SupportsServantReflex t m
117−-- -- back the full `Response`.
183+-- => Dynamic t BaseUrl
118−-- instance HasReflexClient Raw where
184+-- -> Dynamic t (Maybe Text)
119−-- type Input Raw = H.Method ::> ()
185+-- -> Event t l
120−-- type Client Raw = Final (Int, ByteString, MediaType, [HTTP.Header], Response ByteString)
186+-- -> m (Event t (l, ReqResult Book))
121−
187+-- > getBook = client myApi (constDyn host)
122−-- clientWithRoute :: Proxy Raw -> Req -> BaseUrl -> Input Raw -> Client Raw
188+
123−-- clientWithRoute Proxy req baseurl (httpMethod ::> ()) = do
189+instance (SupportsServantReflex t m, ToHttpApiData a, HasClient t m sublayout tag)
124−-- performRequest httpMethod req baseurl
190+ => HasClient t m (Capture capture a :> sublayout) tag where
126−-- -- | If you have a 'Get xs (Headers ls x)' endpoint, the client expects the
192+ type Client t m (Capture capture a :> sublayout) tag =
127−-- -- corresponding headers.
193+ Dynamic t (Either Text a) -> Client t m sublayout tag
129−-- #if MIN_VERSION_base(4,8,0)
195+ clientWithRouteAndResultHandler Proxy q t req baseurl opts wrap val =
130−-- {-# OVERLAPPING #-}
196+ clientWithRouteAndResultHandler
131−-- #endif
197+ (Proxy :: Proxy sublayout) q t (prependToPathParts p req) baseurl opts wrap
132−-- ( MimeUnrender ct a, BuildHeadersTo ls
198+ where p = (fmap . fmap) (toUrlPiece) val
133−-- ) => HasReflexClient (Get (ct ': cts) (Headers ls a)) where
199+
134−-- type Input (Get (ct ': cts) (Headers ls a)) = ()
200+
135−-- type Client (Get (ct ': cts) (Headers ls a)) = Final (Headers ls a)
201+-- VERB (Returning content) --
136−-- clientWithRoute Proxy req baseurl _ = do
202+instance {-# OVERLAPPABLE #-}
137−-- (hdrs, resp) <- performRequestCT (Proxy :: Proxy ct) H.methodGet req baseurl
203+ -- Note [Non-Empty Content Types]
138−-- return $ Headers { getResponse = resp
204+ (MimeUnrender ct a, ReflectMethod method, cts' ~ (ct ': cts), SupportsServantReflex t m
139−-- , getHeadersHList = buildHeadersTo hdrs
205+ ) => HasClient t m (Verb method status cts' a) tag where
140−-- }
206+ type Client t m (Verb method status cts' a) tag =
141−--
207+ Event t tag -> m (Event t (ReqResult tag a))
142−-- -- | A client querying function for @a ':<|>' b@ will actually hand you
208+ -- TODO how to access input types here?
143−-- -- one function for querying @a@ and another one for querying @b@,
209+ -- ExceptT ServantError IO a
144−-- -- stitching them together with ':<|>', which really is just like a pair.
210+ clientWithRouteAndResultHandler Proxy _ _ req baseurl opts wrap trigs =
145−-- --
211+ wrap =<< fmap runIdentity <$> performRequestsCT (Proxy :: Proxy ct) method (constDyn $ Identity $ req') baseurl opts trigs
146−-- -- > type MyApi = "books" :> Get '[JSON] [Book] -- GET /books
212+ where method = E.decodeUtf8 $ reflectMethod (Proxy :: Proxy method)
147−-- -- > :<|> "books" :> ReqBody '[JSON] Book :> Post Book -- POST /books
213+ req' = req { reqMethod = method }
149−-- -- > myApi :: Proxy MyApi
215+
150−-- -- > myApi = Proxy
216+-- -- VERB (No content) --
151−-- -- >
217+instance {-# OVERLAPPING #-}
152−-- -- > getAllBooks :: ExceptT String IO [Book]
218+ (ReflectMethod method, SupportsServantReflex t m) =>
153−-- -- > postNewBook :: Book -> ExceptT String IO Book
219+ HasClient t m (Verb method status cts NoContent) tag where
154−-- -- > (getAllBooks :<|> postNewBook) = client myApi host
220+ type Client t m (Verb method status cts NoContent) tag =
155−-- -- > where host = BaseUrl Http "localhost" 8080
221+ Event t tag -> m (Event t (ReqResult tag NoContent))
156−-- instance (HasReflexClient a, HasReflexClient b) => HasReflexClient (a :<|> b) where
222+ -- TODO: how to access input types here?
157−-- type Input (a :<|> b) = Input a :<|> Input b
223+ -- ExceptT ServantError IO NoContent
158−-- type Client (a :<|> b) = Client a :<|> Client b
224+ clientWithRouteAndResultHandler Proxy _ _ req baseurl opts wrap trigs =
159−-- clientWithRoute Proxy req baseurl (a :<|> b) =
225+ wrap =<< fmap runIdentity <$> performRequestsNoBody method (constDyn $ Identity req) baseurl opts trigs
160−-- clientWithRoute (Proxy :: Proxy a) req baseurl a :<|>
226+ where method = E.decodeUtf8 $ reflectMethod (Proxy :: Proxy method)
161−-- clientWithRoute (Proxy :: Proxy b) req baseurl b
227+
163−-- ------------------------------------------------------------------------------
229+toHeaders :: BuildHeadersTo ls => ReqResult tag a -> ReqResult tag (Headers ls a)
164−-- -- | If you use a 'Capture' in one of your endpoints in your API,
230+toHeaders r =
165−-- -- the corresponding querying function will automatically take
231+ let hdrs = maybe []
166−-- -- an additional argument of the type specified by your 'Capture'.
232+ (\xhr -> fmap (\(h,v) -> (CI.map E.encodeUtf8 h, E.encodeUtf8 v))
167−-- -- That function will take care of inserting a textual representation
233+ (Map.toList $ _xhrResponse_headers xhr))
168−-- -- of this value at the right place in the request path.
234+ (response r)
169−-- --
235+ in ffor r $ \a -> Headers {getResponse = a ,getHeadersHList = buildHeadersTo hdrs}
170−-- -- You can control how values for this type are turned into
236+
171−-- -- text by specifying a 'ToHttpApiData' instance for your type.
237+
172−-- --
238+class BuildHeaderKeysTo hs where
173−-- -- Example:
239+ buildHeaderKeysTo :: Proxy hs -> [CI.CI T.Text]
175−-- -- > type MyApi = "books" :> Capture "isbn" Text :> Get '[JSON] Book
241+instance {-# OVERLAPPABLE #-} BuildHeaderKeysTo '[]
176−-- -- >
242+ where buildHeaderKeysTo _ = []
177−-- -- > myApi :: Proxy MyApi
243+
178−-- -- > myApi = Proxy
244+instance {-# OVERLAPPABLE #-} (BuildHeaderKeysTo xs, KnownSymbol h)
179−-- -- >
245+ => BuildHeaderKeysTo ((Header h v) ': xs) where
180−-- -- > getBook :: Text -> ExceptT String IO Book
246+ buildHeaderKeysTo _ =
181−-- -- > getBook = client myApi host
247+ let
182−-- -- > where host = BaseUrl Http "localhost" 8080
248+ thisKey = CI.mk $ T.pack (symbolVal (Proxy :: Proxy h))
183−-- -- > -- then you can just use "getBook" to query that endpoint
249+ in thisKey : buildHeaderKeysTo (Proxy :: Proxy xs)
184−-- instance (KnownSymbol capture, ToHttpApiData a, HasReflexClient sublayout)
250+
185−-- => HasReflexClient (Capture capture a :> sublayout) where
251+
186−--
252+-- HEADERS Verb (Content) --
187−-- type Input (Capture cap a :> sublayout) = a ::> Input sublayout
253+-- Headers combinator not treated in fully general case,
188−-- type Client (Capture capture a :> sublayout) = Client sublayout
254+-- in order to deny instances for (Headers ls (Capture "id" Int)),
189−--
255+-- a combinator that wouldn't make sense
190−-- clientWithRoute Proxy req baseurl (val ::> rest) =
256+-- TODO Overlapping??
191−-- clientWithRoute (Proxy :: Proxy sublayout)
257+instance {-# OVERLAPPABLE #-}
192−-- (appendToPath p req) baseurl rest
258+ -- Note [Non-Empty Content Types]
193−--
259+ ( MimeUnrender ct a, BuildHeadersTo ls, BuildHeaderKeysTo ls,
194−-- where p = unpack (toUrlPiece val)
260+ ReflectMethod method, cts' ~ (ct ': cts),
195−--
261+ SupportsServantReflex t m
196−-- -- | If you have a 'Delete' endpoint in your API, the client
262+ ) => HasClient t m (Verb method status cts' (Headers ls a)) tag where
197−-- -- side querying function that is created when calling 'client'
263+ type Client t m (Verb method status cts' (Headers ls a)) tag =
198−-- -- will just require an argument that specifies the scheme, host
264+ Event t tag -> m (Event t (ReqResult tag (Headers ls a)))
199−-- -- and port to send the request to.
265+ clientWithRouteAndResultHandler Proxy _ _ req baseurl opts wrap trigs = do
200−-- instance
266+ let method = E.decodeUtf8 $ reflectMethod (Proxy :: Proxy method)
201−-- #if MIN_VERSION_base(4,8,0)
267+ resp <- fmap runIdentity <$> performRequestsCT (Proxy :: Proxy ct) method (constDyn $ Identity req') baseurl opts trigs
202−-- {-# OVERLAPPABLE #-}
268+ wrap $ toHeaders <$> resp
203−-- #endif
269+ where req' = req { respHeaders =
204−-- (MimeUnrender ct a, cts' ~ (ct ': cts)) => HasReflexClient (Delete cts' a) where
270+ OnlyHeaders (Set.fromList (buildHeaderKeysTo (Proxy :: Proxy ls)))
205−-- type Input (Delete cts' a) = ()
271+ }
206−-- type Client (Delete cts' a) = Final a
272+
207−-- clientWithRoute Proxy req baseurl val =
273+
208−-- snd <$> performRequestCT (Proxy :: Proxy ct) H.methodDelete req baseurl val
274+-- HEADERS Verb (No content) --
209−--
275+instance {-# OVERLAPPABLE #-}
210−-- instance
276+ ( BuildHeadersTo ls, BuildHeaderKeysTo ls, ReflectMethod method,
211−-- #if MIN_VERSION_base(4,8,0)
277+ SupportsServantReflex t m
212−-- {-# OVERLAPPING #-}
278+ ) => HasClient t m (Verb method status cts (Headers ls NoContent)) tag where
213−-- #endif
279+ type Client t m (Verb method status cts (Headers ls NoContent)) tag
214−-- HasReflexClient (Delete cts ()) where
280+ = Event t tag -> m (Event t (ReqResult tag (Headers ls NoContent)))
215−-- type Input (Delete cts ()) = ()
281+ clientWithRouteAndResultHandler Proxy _ _ req baseurl opts wrap trigs = do
216−-- type Client (Delete cts ()) = Final ()
282+ let method = E.decodeUtf8 $ reflectMethod (Proxy :: Proxy method)
217−-- clientWithRoute Proxy req baseurl val =
283+ resp <- fmap runIdentity <$> performRequestsNoBody method (constDyn $ Identity req') baseurl opts trigs
218−-- void $ performRequestNoBody H.methodDelete req baseurl val
284+ wrap $ toHeaders <$> resp
219−--
285+ where req' = req {respHeaders =
220−-- -- | If you have a 'Delete xs (Headers ls x)' endpoint, the client expects the
286+ OnlyHeaders (Set.fromList (buildHeaderKeysTo (Proxy :: Proxy ls)))
221−-- -- corresponding headers.
287+ }
223−-- #if MIN_VERSION_base(4,8,0)
289+
224−-- {-# OVERLAPPING #-}
290+
225−-- #endif
291+-- HEADER
226−-- ( MimeUnrender ct a, BuildHeadersTo ls, cts' ~ (ct ': cts)
292+-- > newtype Referer = Referer { referrer :: Text }
227−-- ) => HasReflexClient (Delete cts' (Headers ls a)) where
293+-- > deriving (Eq, Show, Generic, FromText, ToHttpApiData)
228−-- type Input (Delete cts' (Headers ls a)) = ()
294+-- >
229−-- type Client (Delete cts' (Headers ls a)) = Final (Headers ls a)
295+-- > -- GET /view-my-referer
230−-- clientWithRoute Proxy req baseurl _ = do
296+-- > type MyApi = "view-my-referer" :> Header "Referer" Referer :> Get '[JSON] Referer
231−-- (hdrs, resp) <- performRequestCT (Proxy :: Proxy ct) H.methodDelete req baseurl
297+-- >
232−-- return $ Headers { getResponse = resp
298+-- >
233−-- , getHeadersHList = buildHeadersTo hdrs
299+-- > viewReferer :: Maybe Referer -> ExceptT String IO Book
234−-- }
300+-- > viewReferer = client myApi host
235−--
301+-- > where host = BaseUrl Http "localhost" 8080
236−-- -- | If you use a 'Header' in one of your endpoints in your API,
302+-- > -- then you can just use "viewRefer" to query that endpoint
237−-- -- the corresponding querying function will automatically take
303+-- > -- specifying Nothing or e.g Just "http://haskell.org/" as arguments
238−-- -- an additional argument of the type specified by your 'Header',
304+instance (KnownSymbol sym, ToHttpApiData a,
239−-- -- wrapped in Maybe.
305+ HasClient t m sublayout tag, SupportsServantReflex t m)
240−-- --
306+ => HasClient t m (Header sym a :> sublayout) tag where
241−-- -- That function will take care of encoding this argument as Text
307+
242−-- -- in the request headers.
308+ type Client t m (Header sym a :> sublayout) tag =
243−-- --
309+ Dynamic t (Either Text a) -> Client t m sublayout tag
244−-- -- All you need is for your type to have a 'ToHttpApiData' instance.
310+
245−-- --
311+ clientWithRouteAndResultHandler Proxy q t req baseurl opts wrap eVal =
246−-- -- Example:
312+ clientWithRouteAndResultHandler
247−-- --
313+ (Proxy :: Proxy sublayout) q t
248−-- -- > newtype Referer = Referer { referrer :: Text }
314+ (Servant.Common.Req.addHeader hname eVal req)
249−-- -- > deriving (Eq, Show, Generic, FromText, ToHttpApiData)
315+ baseurl opts wrap
250−-- -- >
316+ where hname = T.pack $ symbolVal (Proxy :: Proxy sym)
251−-- -- > -- GET /view-my-referer
317+
252−-- -- > type MyApi = "view-my-referer" :> Header "Referer" Referer :> Get '[JSON] Referer
318+
254−-- -- > myApi :: Proxy MyApi
320+
255−-- -- > myApi = Proxy
321+-- | Using a 'HttpVersion' combinator in your API doesn't affect the client
256−-- -- >
322+-- functions.
257−-- -- > viewReferer :: Maybe Referer -> ExceptT String IO Book
323+instance HasClient t m sublayout tag
258−-- -- > viewReferer = client myApi host
324+ => HasClient t m (HttpVersion :> sublayout) tag where
259−-- -- > where host = BaseUrl Http "localhost" 8080
325+
260−-- -- > -- then you can just use "viewRefer" to query that endpoint
326+ type Client t m (HttpVersion :> sublayout) tag =
261−-- -- > -- specifying Nothing or e.g Just "http://haskell.org/" as arguments
327+ Client t m sublayout tag
262−-- instance (KnownSymbol sym, ToHttpApiData a, HasReflexClient sublayout)
328+
263−-- => HasReflexClient (Header sym a :> sublayout) where
329+ clientWithRouteAndResultHandler Proxy =
264−--
330+ clientWithRouteAndResultHandler (Proxy :: Proxy sublayout)
265−-- type Input (Header sym a :> sublayout) = Maybe a ::> Input sublayout
331+
266−-- type Client (Header sym a :> sublayout) = Client sublayout
332+-- | Using a 'Summary' combinator in your API doesn't affect the client
268−-- clientWithRoute Proxy req baseurl (mval ::> rest) =
334+instance (HasClient t m sublayout tag, KnownSymbol sym)
269−-- clientWithRoute (Proxy :: Proxy sublayout)
335+ => HasClient t m (Summary sym :> sublayout) tag where
271−-- (\value -> Servant.Common.Req.addHeader hname value req)
337+ type Client t m (Summary sym :> sublayout) tag =
272−-- mval
338+ Client t m sublayout tag
274−-- baseurl rest
340+ clientWithRouteAndResultHandler Proxy =
275−--
341+ clientWithRouteAndResultHandler (Proxy :: Proxy sublayout)
276−-- where hname = symbolVal (Proxy :: Proxy sym)
342+
278−-- -- | If you have a 'Post' endpoint in your API, the client
344+
279−-- -- side querying function that is created when calling 'client'
345+
280−-- -- will just require an argument that specifies the scheme, host
346+-- | If you use a 'QueryParam' in one of your endpoints in your API,
281−-- -- and port to send the request to.
347+-- the corresponding querying function will automatically take
282−-- instance
348+-- an additional argument of the type specified by your 'QueryParam',
283−-- #if MIN_VERSION_base(4,8,0)
349+-- enclosed in Maybe.
284−-- {-# OVERLAPPABLE #-}
286−-- (MimeUnrender ct a) => HasReflexClient (Post (ct ': cts) a) where
287−-- type Input (Post (ct ': cts) a) = ()
288−-- type Client (Post (ct ': cts) a) = Final a
289−-- clientWithRoute Proxy req baseurl _ =
290−-- snd <$> performRequestCT (Proxy :: Proxy ct) H.methodPost req baseurl
293−-- #if MIN_VERSION_base(4,8,0)
294−-- {-# OVERLAPPING #-}
296−-- HasReflexClient (Post (ct ': cts) ()) where
297−-- type Input (Post (ct ': cts) ()) = ()
298−-- type Client (Post (ct ': cts) ()) = Final ()
299−-- clientWithRoute Proxy req baseurl _ =
300−-- void $ performRequestNoBody H.methodPost req baseurl
302−-- -- | If you have a 'Post xs (Headers ls x)' endpoint, the client expects the
303−-- -- corresponding headers.
305−-- #if MIN_VERSION_base(4,8,0)
306−-- {-# OVERLAPPING #-}
308−-- ( MimeUnrender ct a, BuildHeadersTo ls
309−-- ) => HasReflexClient (Post (ct ': cts) (Headers ls a)) where
310−-- type Input (Post (ct ': cts) (Headers ls a)) = ()
311−-- type Client (Post (ct ': cts) (Headers ls a)) = Final (Headers ls a)
312−-- clientWithRoute Proxy req baseurl _ = do
313−-- (hdrs, resp) <- performRequestCT (Proxy :: Proxy ct) H.methodPost req baseurl
314−-- return $ Headers { getResponse = resp
315−-- , getHeadersHList = buildHeadersTo hdrs
318−-- -- | If you have a 'Put' endpoint in your API, the client
319−-- -- side querying function that is created when calling 'client'
320−-- -- will just require an argument that specifies the scheme, host
321−-- -- and port to send the request to.
323−-- #if MIN_VERSION_base(4,8,0)
324−-- {-# OVERLAPPABLE #-}
326−-- (MimeUnrender ct a) => HasReflexClient (Put (ct ': cts) a) where
327−-- type Input (Put (ct ': cts) a) = ()
328−-- type Client (Put (ct ': cts) a) = Final a
329−-- clientWithRoute Proxy req baseurl _ =
330−-- snd <$> performRequestCT (Proxy :: Proxy ct) H.methodPut req baseurl
333−-- #if MIN_VERSION_base(4,8,0)
334−-- {-# OVERLAPPING #-}
336−-- HasReflexClient (Put (ct ': cts) ()) where
337−-- type Input (Put (ct ': cts) ()) = ()
338−-- type Client (Put (ct ': cts) ()) = Final ()
339−-- clientWithRoute Proxy req baseurl _ =
340−-- void $ performRequestNoBody H.methodPut req baseurl
342−-- -- | If you have a 'Put xs (Headers ls x)' endpoint, the client expects the
343−-- -- corresponding headers.
345−-- #if MIN_VERSION_base(4,8,0)
346−-- {-# OVERLAPPING #-}
348−-- ( MimeUnrender ct a, BuildHeadersTo ls
349−-- ) => HasReflexClient (Put (ct ': cts) (Headers ls a)) where
350−-- type Input (Put (ct ': cts) (Headers ls a)) = ()
351−-- type Client (Put (ct ': cts) (Headers ls a)) = Final (Headers ls a)
352−-- clientWithRoute Proxy req baseurl _ = do
353−-- (hdrs, resp) <- performRequestCT (Proxy :: Proxy ct) H.methodPut req baseurl
354−-- return $ Headers { getResponse = resp
355−-- , getHeadersHList = buildHeadersTo hdrs
358−-- -- | If you have a 'Patch' endpoint in your API, the client
359−-- -- side querying function that is created when calling 'client'
360−-- -- will just require an argument that specifies the scheme, host
361−-- -- and port to send the request to.
363−-- #if MIN_VERSION_base(4,8,0)
364−-- {-# OVERLAPPABLE #-}
366−-- (MimeUnrender ct a) => HasReflexClient (Patch (ct ': cts) a) where
367−-- type Input (Patch (ct ': cts) a) = ()
368−-- type Client (Patch (ct ': cts) a) = Final a
369−-- clientWithRoute Proxy req baseurl _ =
370−-- snd <$> performRequestCT (Proxy :: Proxy ct) H.methodPatch req baseurl
373−-- #if MIN_VERSION_base(4,8,0)
374−-- {-# OVERLAPPING #-}
376−-- HasReflexClient (Patch (ct ': cts) ()) where
377−-- type Input (Patch (ct ': cts) ()) = ()
378−-- type Client (Patch (ct ': cts) ()) = Final ()
379−-- clientWithRoute Proxy req baseurl _ =
380−-- void $ performRequestNoBody H.methodPatch req baseurl
382−-- -- | If you have a 'Patch xs (Headers ls x)' endpoint, the client expects the
383−-- -- corresponding headers.
385−-- #if MIN_VERSION_base(4,8,0)
386−-- {-# OVERLAPPING #-}
388−-- ( MimeUnrender ct a, BuildHeadersTo ls
389−-- ) => HasReflexClient (Patch (ct ': cts) (Headers ls a)) where
390−-- type Input (Patch (ct ': cts) (Headers ls a)) = ()
391−-- type Client (Patch (ct ': cts) (Headers ls a)) = Final (Headers ls a)
392−-- clientWithRoute Proxy req baseurl _ = do
393−-- (hdrs, resp) <- performRequestCT (Proxy :: Proxy ct) H.methodPatch req baseurl
394−-- return $ Headers { getResponse = resp
395−-- , getHeadersHList = buildHeadersTo hdrs
398−-- -- | If you use a 'QueryParam' in one of your endpoints in your API,
399−-- -- the corresponding querying function will automatically take
400−-- -- an additional argument of the type specified by your 'QueryParam',
401−-- -- enclosed in Maybe.
403−-- -- If you give Nothing, nothing will be added to the query string.
405−-- -- If you give a non-'Nothing' value, this function will take care
406−-- -- of inserting a textual representation of this value in the query string.
408−-- -- You can control how values for your type are turned into
409−-- -- text by specifying a 'ToHttpApiData' instance for your type.
413−-- -- > type MyApi = "books" :> QueryParam "author" Text :> Get '[JSON] [Book]
415−-- -- > myApi :: Proxy MyApi
416−-- -- > myApi = Proxy
418−-- -- > getBooksBy :: Maybe Text -> ExceptT String IO [Book]
419−-- -- > getBooksBy = client myApi host
420−-- -- > where host = BaseUrl Http "localhost" 8080
421−-- -- > -- then you can just use "getBooksBy" to query that endpoint.
422−-- -- > -- 'getBooksBy Nothing' for all books
423−-- -- > -- 'getBooksBy (Just "Isaac Asimov")' to get all books by Isaac Asimov
424−-- instance (KnownSymbol sym, ToHttpApiData a, HasReflexClient sublayout)
425−-- => HasReflexClient (QueryParam sym a :> sublayout) where
427−-- type Input (QueryParam sym a :> sublayout) = Maybe a ::> Input sublayout
428−-- type Client (QueryParam sym a :> sublayout) = Client sublayout
430−-- -- if mparam = Nothing, we don't add it to the query string
431−-- clientWithRoute Proxy req baseurl (mparam ::> rest) =
432−-- clientWithRoute (Proxy :: Proxy sublayout)
434−-- (flip (appendToQueryString pname) req . Just)
439−-- where pname = cs pname'
440−-- pname' = symbolVal (Proxy :: Proxy sym)
441−-- mparamText = fmap toQueryParam mparam
443−-- -- | If you use a 'QueryParams' in one of your endpoints in your API,
444−-- -- the corresponding querying function will automatically take
445−-- -- an additional argument, a list of values of the type specified
446−-- -- by your 'QueryParams'.
448−-- -- If you give an empty list, nothing will be added to the query string.
450−-- -- Otherwise, this function will take care
451−-- -- of inserting a textual representation of your values in the query string,
452−-- -- under the same query string parameter name.
454−-- -- You can control how values for your type are turned into
455−-- -- text by specifying a 'ToHttpApiData' instance for your type.
459−-- -- > type MyApi = "books" :> QueryParams "authors" Text :> Get '[JSON] [Book]
461−-- -- > myApi :: Proxy MyApi
462−-- -- > myApi = Proxy
464−-- -- > getBooksBy :: [Text] -> ExceptT String IO [Book]
465−-- -- > getBooksBy = client myApi host
466−-- -- > where host = BaseUrl Http "localhost" 8080
467−-- -- > -- then you can just use "getBooksBy" to query that endpoint.
468−-- -- > -- 'getBooksBy []' for all books
469−-- -- > -- 'getBooksBy ["Isaac Asimov", "Robert A. Heinlein"]'
470−-- -- > -- to get all books by Asimov and Heinlein
471−-- instance (KnownSymbol sym, ToHttpApiData a, HasReflexClient sublayout)
472−-- => HasReflexClient (QueryParams sym a :> sublayout) where
474−-- type Input (QueryParams sym a :> sublayout) = [a] ::> Input sublayout
475−-- type Client (QueryParams sym a :> sublayout) = Client sublayout
477−-- clientWithRoute Proxy req baseurl (paramlist ::> rest) =
478−-- clientWithRoute (Proxy :: Proxy sublayout)
479−-- (foldl' (\ req' -> maybe req' (flip (appendToQueryString pname) req' . Just))
485−-- where pname = cs pname'
351+-- If you give Nothing, nothing will be added to the query string.
486−-- pname' = symbolVal (Proxy :: Proxy sym)
487−-- paramlist' = map (Just . toQueryParam) paramlist
489−-- -- | If you use a 'QueryFlag' in one of your endpoints in your API,
353+-- If you give a non-'Nothing' value, this function will take care
490−-- -- the corresponding querying function will automatically take
354+-- of inserting a textual representation of this value in the query string.
491−-- -- an additional 'Bool' argument.
493−-- -- If you give 'False', nothing will be added to the query string.
495−-- -- Otherwise, this function will insert a value-less query string
496−-- -- parameter under the name associated to your 'QueryFlag'.
500−-- -- > type MyApi = "books" :> QueryFlag "published" :> Get '[JSON] [Book]
502−-- -- > myApi :: Proxy MyApi
503−-- -- > myApi = Proxy
505−-- -- > getBooks :: Bool -> ExceptT String IO [Book]
506−-- -- > getBooks = client myApi host
507−-- -- > where host = BaseUrl Http "localhost" 8080
508−-- -- > -- then you can just use "getBooks" to query that endpoint.
509−-- -- > -- 'getBooksBy False' for all books
510−-- -- > -- 'getBooksBy True' to only get _already published_ books
511−-- instance (KnownSymbol sym, HasReflexClient sublayout)
512−-- => HasReflexClient (QueryFlag sym :> sublayout) where
514−-- type Input (QueryFlag sym :> sublayout) = Bool ::> Input sublayout
356+-- You can control how values for your type are turned into
515−-- type Client (QueryFlag sym :> sublayout) = Client sublayout
357+-- text by specifying a 'ToHttpApiData' instance for your type.
517−-- clientWithRoute Proxy req baseurl (flag ::> rest) =
359+-- Example:
518−-- clientWithRoute (Proxy :: Proxy sublayout)
520−-- then appendToQueryString paramname Nothing req
525−-- where paramname = cs $ symbolVal (Proxy :: Proxy sym)
361+-- > type MyApi = "books" :> QueryParam "author" Text :> Get '[JSON] [Book]
363+-- > myApi :: Proxy MyApi
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
375+ type Client t m (QueryParam sym a :> sublayout) tag =
376+ Dynamic t (QParam a) -> Client t m sublayout tag
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
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)
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'.
396+-- If you give an empty list, nothing will be added to the query string.
528−-- -- | If you use a 'ReqBody' in one of your endpoints in your API,
398+-- Otherwise, this function will take care
529−-- -- the corresponding querying function will automatically take
399+-- of inserting a textual representation of your values in the query string,
530−-- -- an additional argument of the type specified by your 'ReqBody'.
400+-- under the same query string parameter name.
531−-- -- That function will take care of encoding this argument as JSON and
532−-- -- of using it as the request body.
534−-- -- All you need is for your type to have a 'ToJSON' instance.
538−-- -- > type MyApi = "books" :> ReqBody '[JSON] Book :> Post '[JSON] Book
540−-- -- > myApi :: Proxy MyApi
541−-- -- > myApi = Proxy
543−-- -- > addBook :: Book -> ExceptT String IO Book
544−-- -- > addBook = client myApi host
545−-- -- > where host = BaseUrl Http "localhost" 8080
546−-- -- > -- then you can just use "addBook" to query that endpoint
547−-- instance (MimeRender ct a, HasReflexClient sublayout)
548−-- => HasReflexClient (ReqBody (ct ': cts) a :> sublayout) where
550−-- type Input (ReqBody (ct ': cts) a :> sublayout) = a ::> Input sublayout
402+-- You can control how values for your type are turned into
551−-- type Client (ReqBody (ct ': cts) a :> sublayout) = Client sublayout
403+-- text by specifying a 'ToHttpApiData' instance for your type.
553−-- clientWithRoute Proxy req baseurl (body ::> rest) =
405+-- Example:
554−-- clientWithRoute (Proxy :: Proxy sublayout)
555−-- (let ctProxy = Proxy :: Proxy ct
556−-- in setRQBody (mimeRender ctProxy body)
557−-- (contentType ctProxy)
562−-- -- | Make the querying function append @path@ to the request path.
407+-- > type MyApi = "books" :> QueryParams "authors" Text :> Get '[JSON] [Book]
563−-- instance (KnownSymbol path, HasReflexClient sublayout) => HasReflexClient (path :> sublayout) where
408+-- >
564−-- type Input (path :> sublayout) = Input sublayout
409+-- > myApi :: Proxy MyApi
565−-- type Client (path :> sublayout) = Client sublayout
410+-- > myApi = Proxy
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
422+ type Client t m (QueryParams sym a :> sublayout) tag =
423+ Dynamic t [a] -> Client t m sublayout tag
425+ clientWithRouteAndResultHandler Proxy q t req baseurl opts wrap paramlist =
426+ clientWithRouteAndResultHandler (Proxy :: Proxy sublayout) q t req' baseurl opts wrap
428+ where req' = req { qParams = (T.pack pname, params') : qParams req }
429+ pname = symbolVal (Proxy :: Proxy sym)
430+ params' = QueryPartParams $ (fmap . fmap) toQueryParam
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.
567−-- clientWithRoute Proxy req baseurl val =
439+-- If you give 'False', nothing will be added to the query string.
568−-- clientWithRoute (Proxy :: Proxy sublayout)
569−-- (appendToPath p req)
572−-- where p = symbolVal (Proxy :: Proxy path)
441+-- Otherwise, this function will insert a value-less query string
442+-- parameter under the name associated to your 'QueryFlag'.
574−-- instance HasReflexClient api => HasReflexClient (Vault :> api) where
444+-- Example:
575−-- type Input (Vault :> api) = Input api
576−-- type Client (Vault :> api) = Client api
578−-- clientWithRoute Proxy req baseurl val =
446+-- > type MyApi = "books" :> QueryFlag "published" :> Get '[JSON] [Book]
579−-- clientWithRoute (Proxy :: Proxy api) req baseurl val
447+-- >
448+-- > myApi :: Proxy MyApi
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
459+instance (KnownSymbol sym, HasClient t m sublayout tag, Reflex t)
460+ => HasClient t m (QueryFlag sym :> sublayout) tag where
462+ type Client t m (QueryFlag sym :> sublayout) tag =
463+ Dynamic t Bool -> Client t m sublayout tag
465+ clientWithRouteAndResultHandler Proxy q t req baseurl opts wrap flag =
466+ clientWithRouteAndResultHandler (Proxy :: Proxy sublayout) q t req' baseurl opts wrap
468+ where req' = req { qParams = thisPair : qParams req }
469+ thisPair = (T.pack pName, QueryPartFlag flag) :: (Text, QueryPart t)
470+ pName = symbolVal (Proxy :: Proxy sym)
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 ()))
478+ -> m (Event t (ReqResult tag ()))
480+ clientWithRouteAndResultHandler _ _ _ _ baseurl _ wrap xhrs triggers = do
482+ let xhrs' = liftA2 (\x path -> case x of
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 ())
490+ resps <- performRequestsAsync okReq
491+ wrap $ leftmost [ uncurry RequestFailure <$> badReq
492+ , evalResponse (const $ Right ()) <$> resps
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.
581−-- instance HasReflexClient api => HasReflexClient (RemoteHost :> api) where
502+-- All you need is for your type to have a 'ToJSON' instance.
582−-- type Input (RemoteHost :> api) = Input api
583−-- type Client (RemoteHost :> api) = Client api
585−-- clientWithRoute Proxy req baseurl val =
504+-- Example:
586−-- clientWithRoute (Proxy :: Proxy api) req baseurl val
588−-- instance HasReflexClient api => HasReflexClient (IsSecure :> api) where
506+-- > type MyApi = "books" :> ReqBody '[JSON] Book :> Post '[JSON] Book
589−-- type Input (IsSecure :> api) = Input api
507+-- >
590−-- type Client (IsSecure :> api) = Client api
508+-- > myApi :: Proxy MyApi
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
516+instance (MimeRender ct a, HasClient t m sublayout tag, Reflex t)
517+ => HasClient t m (ReqBody (ct ': cts) a :> sublayout) tag where
519+ type Client t m (ReqBody (ct ': cts) a :> sublayout) tag =
520+ Dynamic t (Either Text a) -> Client t m sublayout tag
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))
533+-- | Make the querying function append @path@ to the request path.
534+instance (KnownSymbol path, HasClient t m sublayout tag, Reflex t) => HasClient t m (path :> sublayout) tag where
535+ type Client t m (path :> sublayout) tag = Client t m sublayout tag
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
541+ where p = symbolVal (Proxy :: Proxy path)
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
547+ clientWithRouteAndResultHandler Proxy =
548+ clientWithRouteAndResultHandler (Proxy :: Proxy api)
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
554+ clientWithRouteAndResultHandler Proxy =
555+ clientWithRouteAndResultHandler (Proxy :: Proxy api)
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
562+ clientWithRouteAndResultHandler Proxy =
563+ clientWithRouteAndResultHandler (Proxy :: Proxy api)
566+instance (HasClient t m api tag, Reflex t)
567+ => HasClient t m (BasicAuth realm usr :> api) tag where
569+ type Client t m (BasicAuth realm usr :> api) tag = Dynamic t (Maybe BasicAuthData)
570+ -> Client t m api tag
572+ clientWithRouteAndResultHandler Proxy q t req baseurl opts wrap authdata =
573+ clientWithRouteAndResultHandler (Proxy :: Proxy api) q t req' baseurl opts wrap
575+ req' = req { authData = Just authdata }
577+-- instance HasClient t m subapi =>
578+-- HasClient t m (WithNamedConfig name config subapi) where
580+-- type Client t m (WithNamedConfig name config subapi) = Client t m subapi
581+-- clientWithRoute Proxy q = clientWithRoute (Proxy :: Proxy subapi) q
584+{- Note [Non-Empty Content Types]
585+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
588+ instance (..., cts' ~ (ct ': cts)) => ... cts' ...
590+It may seem to make more sense to have:
592+ instance (...) => ... (ct ': cts) ...
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).
601+-- SUPPORT FOR servant-auth --
603+-- For JavaScript clients we should be sending/storing JSON web tokens in a
604+-- way that is inaccessible to JavaScript.
592−-- clientWithRoute Proxy req baseurl val =
606+-- For @servant-auth@ this is done with HTTP-only cookies. In a Reflex-DOM
593−-- clientWithRoute (Proxy :: Proxy api) req baseurl val
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
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
615+ type Client t m (Auth.Auth auths a :> api) tag = Client t m api tag
616+ clientWithRouteAndResultHandler Proxy = clientWithRouteAndResultHandler (Proxy :: Proxy api)
619+type family HasCookieAuth xs :: Constraint where
620+ HasCookieAuth (Auth.Cookie ': xs) = ()
621+ HasCookieAuth (x ': xs) = HasCookieAuth xs
622+ HasCookieAuth '[] = CookieAuthNotEnabled
624+class CookieAuthNotEnabled