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