master..950e322 · servant-reflex

git.iko.soy/servant-reflex

on 950e322 help sign in

5 files changed+41−71

since splitsnapshots

unifiedsplit

.gitignore−2 README.md+1−1 nix/reflex-platform.nix+2−2 src/Servant/Reflex.hs+16−31 src/Servant/Reflex/Multi.hs+22−35

.gitignore−2

@@ -7,5 +7,3 @@ log

77*.stats

88out

99/.stack-work/

10−TAGS

11−dist-newstyle

README.md+1−1

@@ -7,7 +7,7 @@

77Keeping your frontend in sync with your API server can be difficult - when the

88API changes its input parameters or return type, XHR requests from the

99frontend will fail at runtime. If your API is defined by

10−[servant](https://haskell-servant.readthedocs.io) combinators, you can use

10+[servant](haskell-servant.readthedocs.io) combinators, you can use

1111`servant-reflex` to share the API between the server and frontend.

1212Syncronization between is checked at compile time, and rather than building XHR

1313requests by hand, API endpoints are available behind `reflex`'s FRP semantics.

nix/reflex-platform.nix+2−2

@@ -1,7 +1,7 @@

11let

2− rev = "1aba6f367982bd6dd78ec2fda75ab246a62d32c5" ;

2+ rev = "df0bdcca5eb2a3236ec0496e4430d91876b29cf5";

33in import (builtins.fetchTarball

44 {

55 url = "https://github.com/reflex-frp/reflex-platform/archive/${rev}.tar.gz";

6− sha256 = "137vg6i8yy4lp6rz4wbvvhfcc9d9qf7j1b3fnng3r7sj63k7j664" ;

6+ sha256 = "1ja3vkq9px8f9iyiazq44mamaahgiphi9l236pvzbl5jvhi5c4qr";

77 }) {}

src/Servant/Reflex.hs+16−31

@@ -39,36 +39,34 @@ module Servant.Reflex

3939

4040------------------------------------------------------------------------------

4141import Control.Applicative

42+import Data.Monoid ((<>))

43+import qualified Data.Set as Set

44+import qualified Data.Text.Encoding as E

4245import qualified Data.CaseInsensitive as CI

4346import Data.Functor.Identity

44−import qualified Data.Map as Map

45−import Data.Monoid ((<>))

4647import Data.Proxy (Proxy (..))

47−import qualified Data.Set as Set

48+import qualified Data.Map as Map

4849import Data.Text (Text)

4950import qualified Data.Text as T

50−import qualified Data.Text.Encoding as E

5151import GHC.Exts (Constraint)

5252import GHC.TypeLits (KnownSymbol, symbolVal)

53−import Servant.API ((:<|>) (..), (:>), BasicAuth,

54− BasicAuthData, BuildHeadersTo (..),

55− Capture, Header, Headers (..),

56− HttpVersion, IsSecure,

57− MimeRender (..), MimeUnrender,

53+import Servant.API ((:<|>)(..),(:>), BasicAuth,

54+ BasicAuthData, BuildHeadersTo(..),

55+ Capture, contentType, Header,

56+ Headers(..), HttpVersion, IsSecure,

57+ MimeRender(..), MimeUnrender,

5858 NoContent, QueryFlag, QueryParam,

59− QueryParams, Raw, ReflectMethod (..),

59+ QueryParams, Raw, ReflectMethod(..),

6060 RemoteHost, ReqBody,

61− ToHttpApiData (..), Vault, Verb,

62− contentType)

63−import Servant.API.Description (Summary)

61+ ToHttpApiData(..), Vault, Verb)

6462import qualified Servant.Auth as Auth

6563

6664import Reflex.Dom.Core (Dynamic, Event, Reflex,

67− XhrRequest (..), XhrResponse (..),

68− XhrResponseHeaders (..),

69− attachPromptlyDynWith, constDyn, ffor,

70− fmapMaybe, leftmost,

71− performRequestsAsync)

65+ XhrRequest(..),

66+ XhrResponseHeaders(..),

67+ XhrResponse(..), attachPromptlyDynWith, constDyn, ffor, fmapMaybe,

68+ leftmost, performRequestsAsync,

69+ )

7270------------------------------------------------------------------------------

7371import Servant.Common.BaseUrl (BaseUrl(..), Scheme(..), baseUrlWidget,

7472 showBaseUrl,

@@ -329,19 +327,6 @@ instance HasClient t m sublayout tag

329327 clientWithRouteAndResultHandler Proxy =

330328 clientWithRouteAndResultHandler (Proxy :: Proxy sublayout)

331329

332−-- | Using a 'Summary' combinator in your API doesn't affect the client

333−-- functions.

334−instance (HasClient t m sublayout tag, KnownSymbol sym)

335− => HasClient t m (Summary sym :> sublayout) tag where

336−

337− type Client t m (Summary sym :> sublayout) tag =

338− Client t m sublayout tag

339−

340− clientWithRouteAndResultHandler Proxy =

341− clientWithRouteAndResultHandler (Proxy :: Proxy sublayout)

342−

343−

344−

345330

346331-- | If you use a 'QueryParam' in one of your endpoints in your API,

347332-- the corresponding querying function will automatically take

src/Servant/Reflex/Multi.hs+22−35

@@ -37,30 +37,28 @@ module Servant.Reflex.Multi (

3737 ) where

3838

3939------------------------------------------------------------------------------

40−import Control.Applicative (liftA2)

41−import Data.Functor.Compose (Compose (..), getCompose)

42−import Data.Proxy (Proxy (..))

43−import qualified Data.Set as Set

44−import Data.Text (Text)

45−import qualified Data.Text as T

46−import qualified Data.Text.Encoding as E

47−import GHC.TypeLits (KnownSymbol, symbolVal)

48−import Servant.API ((:<|>) (..), (:>), BasicAuth,

49− BasicAuthData, BuildHeadersTo (..),

50− Capture, Header, Headers (..),

51− HttpVersion, IsSecure,

52− MimeRender (..), MimeUnrender,

53− NoContent, QueryFlag, QueryParam,

54− QueryParams, Raw, ReflectMethod (..),

55− RemoteHost, ReqBody,

56− ToHttpApiData (..), Vault, Verb,

57− contentType)

58−import Servant.API.Description (Summary)

59−

60−import Reflex.Dom.Core (Dynamic, Event, Reflex,

61− XhrRequest (..),

62− XhrResponseHeaders (..),

63− attachPromptlyDynWith, constDyn)

40+import Control.Applicative (liftA2)

41+import Data.Functor.Compose (Compose (..), getCompose)

42+import Data.Proxy (Proxy (..))

43+import qualified Data.Set as Set

44+import Data.Text (Text)

45+import qualified Data.Text as T

46+import qualified Data.Text.Encoding as E

47+import GHC.TypeLits (KnownSymbol, symbolVal)

48+import Servant.API ((:<|>) (..), (:>), BasicAuth,

49+ BasicAuthData, BuildHeadersTo (..),

50+ Capture, Header, Headers (..),

51+ HttpVersion, IsSecure, MimeRender (..),

52+ MimeUnrender, NoContent, QueryFlag,

53+ QueryParam, QueryParams, Raw,

54+ ReflectMethod (..), RemoteHost,

55+ ReqBody, ToHttpApiData (..), Vault,

56+ Verb, contentType)

57+

58+import Reflex.Dom.Core (Dynamic, Event, Reflex,

59+ XhrRequest (..),

60+ XhrResponseHeaders (..),

61+ attachPromptlyDynWith, constDyn)

6462------------------------------------------------------------------------------

6563import Servant.Common.BaseUrl (BaseUrl (..), Scheme (..),

6664 SupportsServantReflex)

@@ -242,17 +240,6 @@ instance HasClientMulti t m sublayout f tag

242240 clientWithRouteMulti (Proxy :: Proxy sublayout) q f tag

243241

244242

245−------------------------------------------------------------------------------

246−instance (HasClientMulti t m sublayout f tag, KnownSymbol sym)

247− => HasClientMulti t m (Summary sym :> sublayout) f tag where

248−

249− type ClientMulti t m (Summary sym :> sublayout) f tag =

250− ClientMulti t m sublayout f tag

251−

252− clientWithRouteMulti Proxy q f tag =

253− clientWithRouteMulti (Proxy :: Proxy sublayout) q f tag

254−

255−

256243------------------------------------------------------------------------------

257244instance (KnownSymbol sym,

258245 ToHttpApiData a,