summaryrefslogtreecommitdiff
path: root/src/Data/GraphQL.hs
diff options
context:
space:
mode:
Diffstat (limited to 'src/Data/GraphQL.hs')
-rw-r--r--src/Data/GraphQL.hs36
1 files changed, 36 insertions, 0 deletions
diff --git a/src/Data/GraphQL.hs b/src/Data/GraphQL.hs
new file mode 100644
index 0000000..47ca2b0
--- /dev/null
+++ b/src/Data/GraphQL.hs
@@ -0,0 +1,36 @@
+-- | This module provides the functions to parse and execute @GraphQL@ queries.
+module Data.GraphQL where
+
+import Control.Monad (MonadPlus)
+
+import qualified Data.Text as T
+
+import qualified Data.Aeson as Aeson
+import Text.Megaparsec ( errorBundlePretty
+ , parse
+ )
+
+import Data.GraphQL.Execute
+import Data.GraphQL.Parser
+import Data.GraphQL.Schema
+
+import Data.GraphQL.Error
+
+-- | Takes a 'Schema' and text representing a @GraphQL@ request document.
+-- If the text parses correctly as a @GraphQL@ query the query is
+-- executed according to the given 'Schema'.
+--
+-- Returns the response as an @Aeson.@'Aeson.Value'.
+graphql :: MonadPlus m => Schema m -> T.Text -> m Aeson.Value
+graphql = flip graphqlSubs $ const Nothing
+
+-- | Takes a 'Schema', a variable substitution function and text
+-- representing a @GraphQL@ request document. If the text parses
+-- correctly as a @GraphQL@ query the substitution is applied to the
+-- query and the query is then executed according to the given 'Schema'.
+--
+-- Returns the response as an @Aeson.@'Aeson.Value'.
+graphqlSubs :: MonadPlus m => Schema m -> Subs -> T.Text -> m Aeson.Value
+graphqlSubs schema f =
+ either (parseError . errorBundlePretty) (execute schema f)
+ . parse document ""