{-# LANGUAGE DeriveTraversable #-}
{-# LANGUAGE FlexibleInstances #-}
{-# LANGUAGE OverloadedStrings #-}

{-|
Module      :  Data.GraphQL.Result
Maintainer  :  Brandon Chinn <brandonchinn178@gmail.com>
Stability   :  experimental
Portability :  portable

Definitions parsing responses from a GraphQL API.
-}
module Data.GraphQL.Result (
  GraphQLResult (..),
  getErrors,
  getResult,
) where

import Data.Aeson (FromJSON (..), withObject, (.!=), (.:?))

import Data.GraphQL.Error (GraphQLError)

-- | A result of a GraphQL query.
data GraphQLResult r = GraphQLResult
  { forall r. GraphQLResult r -> [GraphQLError]
resultErrors :: [GraphQLError]
  , forall r. GraphQLResult r -> Maybe r
resultResult :: Maybe r
  }
  deriving (Int -> GraphQLResult r -> ShowS
[GraphQLResult r] -> ShowS
GraphQLResult r -> String
(Int -> GraphQLResult r -> ShowS)
-> (GraphQLResult r -> String)
-> ([GraphQLResult r] -> ShowS)
-> Show (GraphQLResult r)
forall r. Show r => Int -> GraphQLResult r -> ShowS
forall r. Show r => [GraphQLResult r] -> ShowS
forall r. Show r => GraphQLResult r -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
$cshowsPrec :: forall r. Show r => Int -> GraphQLResult r -> ShowS
showsPrec :: Int -> GraphQLResult r -> ShowS
$cshow :: forall r. Show r => GraphQLResult r -> String
show :: GraphQLResult r -> String
$cshowList :: forall r. Show r => [GraphQLResult r] -> ShowS
showList :: [GraphQLResult r] -> ShowS
Show, (forall a b. (a -> b) -> GraphQLResult a -> GraphQLResult b)
-> (forall a b. a -> GraphQLResult b -> GraphQLResult a)
-> Functor GraphQLResult
forall a b. a -> GraphQLResult b -> GraphQLResult a
forall a b. (a -> b) -> GraphQLResult a -> GraphQLResult b
forall (f :: * -> *).
(forall a b. (a -> b) -> f a -> f b)
-> (forall a b. a -> f b -> f a) -> Functor f
$cfmap :: forall a b. (a -> b) -> GraphQLResult a -> GraphQLResult b
fmap :: forall a b. (a -> b) -> GraphQLResult a -> GraphQLResult b
$c<$ :: forall a b. a -> GraphQLResult b -> GraphQLResult a
<$ :: forall a b. a -> GraphQLResult b -> GraphQLResult a
Functor, (forall m. Monoid m => GraphQLResult m -> m)
-> (forall m a. Monoid m => (a -> m) -> GraphQLResult a -> m)
-> (forall m a. Monoid m => (a -> m) -> GraphQLResult a -> m)
-> (forall a b. (a -> b -> b) -> b -> GraphQLResult a -> b)
-> (forall a b. (a -> b -> b) -> b -> GraphQLResult a -> b)
-> (forall b a. (b -> a -> b) -> b -> GraphQLResult a -> b)
-> (forall b a. (b -> a -> b) -> b -> GraphQLResult a -> b)
-> (forall a. (a -> a -> a) -> GraphQLResult a -> a)
-> (forall a. (a -> a -> a) -> GraphQLResult a -> a)
-> (forall a. GraphQLResult a -> [a])
-> (forall a. GraphQLResult a -> Bool)
-> (forall a. GraphQLResult a -> Int)
-> (forall a. Eq a => a -> GraphQLResult a -> Bool)
-> (forall a. Ord a => GraphQLResult a -> a)
-> (forall a. Ord a => GraphQLResult a -> a)
-> (forall a. Num a => GraphQLResult a -> a)
-> (forall a. Num a => GraphQLResult a -> a)
-> Foldable GraphQLResult
forall a. Eq a => a -> GraphQLResult a -> Bool
forall a. Num a => GraphQLResult a -> a
forall a. Ord a => GraphQLResult a -> a
forall m. Monoid m => GraphQLResult m -> m
forall a. GraphQLResult a -> Bool
forall a. GraphQLResult a -> Int
forall a. GraphQLResult a -> [a]
forall a. (a -> a -> a) -> GraphQLResult a -> a
forall m a. Monoid m => (a -> m) -> GraphQLResult a -> m
forall b a. (b -> a -> b) -> b -> GraphQLResult a -> b
forall a b. (a -> b -> b) -> b -> GraphQLResult a -> b
forall (t :: * -> *).
(forall m. Monoid m => t m -> m)
-> (forall m a. Monoid m => (a -> m) -> t a -> m)
-> (forall m a. Monoid m => (a -> m) -> t a -> m)
-> (forall a b. (a -> b -> b) -> b -> t a -> b)
-> (forall a b. (a -> b -> b) -> b -> t a -> b)
-> (forall b a. (b -> a -> b) -> b -> t a -> b)
-> (forall b a. (b -> a -> b) -> b -> t a -> b)
-> (forall a. (a -> a -> a) -> t a -> a)
-> (forall a. (a -> a -> a) -> t a -> a)
-> (forall a. t a -> [a])
-> (forall a. t a -> Bool)
-> (forall a. t a -> Int)
-> (forall a. Eq a => a -> t a -> Bool)
-> (forall a. Ord a => t a -> a)
-> (forall a. Ord a => t a -> a)
-> (forall a. Num a => t a -> a)
-> (forall a. Num a => t a -> a)
-> Foldable t
$cfold :: forall m. Monoid m => GraphQLResult m -> m
fold :: forall m. Monoid m => GraphQLResult m -> m
$cfoldMap :: forall m a. Monoid m => (a -> m) -> GraphQLResult a -> m
foldMap :: forall m a. Monoid m => (a -> m) -> GraphQLResult a -> m
$cfoldMap' :: forall m a. Monoid m => (a -> m) -> GraphQLResult a -> m
foldMap' :: forall m a. Monoid m => (a -> m) -> GraphQLResult a -> m
$cfoldr :: forall a b. (a -> b -> b) -> b -> GraphQLResult a -> b
foldr :: forall a b. (a -> b -> b) -> b -> GraphQLResult a -> b
$cfoldr' :: forall a b. (a -> b -> b) -> b -> GraphQLResult a -> b
foldr' :: forall a b. (a -> b -> b) -> b -> GraphQLResult a -> b
$cfoldl :: forall b a. (b -> a -> b) -> b -> GraphQLResult a -> b
foldl :: forall b a. (b -> a -> b) -> b -> GraphQLResult a -> b
$cfoldl' :: forall b a. (b -> a -> b) -> b -> GraphQLResult a -> b
foldl' :: forall b a. (b -> a -> b) -> b -> GraphQLResult a -> b
$cfoldr1 :: forall a. (a -> a -> a) -> GraphQLResult a -> a
foldr1 :: forall a. (a -> a -> a) -> GraphQLResult a -> a
$cfoldl1 :: forall a. (a -> a -> a) -> GraphQLResult a -> a
foldl1 :: forall a. (a -> a -> a) -> GraphQLResult a -> a
$ctoList :: forall a. GraphQLResult a -> [a]
toList :: forall a. GraphQLResult a -> [a]
$cnull :: forall a. GraphQLResult a -> Bool
null :: forall a. GraphQLResult a -> Bool
$clength :: forall a. GraphQLResult a -> Int
length :: forall a. GraphQLResult a -> Int
$celem :: forall a. Eq a => a -> GraphQLResult a -> Bool
elem :: forall a. Eq a => a -> GraphQLResult a -> Bool
$cmaximum :: forall a. Ord a => GraphQLResult a -> a
maximum :: forall a. Ord a => GraphQLResult a -> a
$cminimum :: forall a. Ord a => GraphQLResult a -> a
minimum :: forall a. Ord a => GraphQLResult a -> a
$csum :: forall a. Num a => GraphQLResult a -> a
sum :: forall a. Num a => GraphQLResult a -> a
$cproduct :: forall a. Num a => GraphQLResult a -> a
product :: forall a. Num a => GraphQLResult a -> a
Foldable, Functor GraphQLResult
Foldable GraphQLResult
(Functor GraphQLResult, Foldable GraphQLResult) =>
(forall (f :: * -> *) a b.
 Applicative f =>
 (a -> f b) -> GraphQLResult a -> f (GraphQLResult b))
-> (forall (f :: * -> *) a.
    Applicative f =>
    GraphQLResult (f a) -> f (GraphQLResult a))
-> (forall (m :: * -> *) a b.
    Monad m =>
    (a -> m b) -> GraphQLResult a -> m (GraphQLResult b))
-> (forall (m :: * -> *) a.
    Monad m =>
    GraphQLResult (m a) -> m (GraphQLResult a))
-> Traversable GraphQLResult
forall (t :: * -> *).
(Functor t, Foldable t) =>
(forall (f :: * -> *) a b.
 Applicative f =>
 (a -> f b) -> t a -> f (t b))
-> (forall (f :: * -> *) a. Applicative f => t (f a) -> f (t a))
-> (forall (m :: * -> *) a b.
    Monad m =>
    (a -> m b) -> t a -> m (t b))
-> (forall (m :: * -> *) a. Monad m => t (m a) -> m (t a))
-> Traversable t
forall (m :: * -> *) a.
Monad m =>
GraphQLResult (m a) -> m (GraphQLResult a)
forall (f :: * -> *) a.
Applicative f =>
GraphQLResult (f a) -> f (GraphQLResult a)
forall (m :: * -> *) a b.
Monad m =>
(a -> m b) -> GraphQLResult a -> m (GraphQLResult b)
forall (f :: * -> *) a b.
Applicative f =>
(a -> f b) -> GraphQLResult a -> f (GraphQLResult b)
$ctraverse :: forall (f :: * -> *) a b.
Applicative f =>
(a -> f b) -> GraphQLResult a -> f (GraphQLResult b)
traverse :: forall (f :: * -> *) a b.
Applicative f =>
(a -> f b) -> GraphQLResult a -> f (GraphQLResult b)
$csequenceA :: forall (f :: * -> *) a.
Applicative f =>
GraphQLResult (f a) -> f (GraphQLResult a)
sequenceA :: forall (f :: * -> *) a.
Applicative f =>
GraphQLResult (f a) -> f (GraphQLResult a)
$cmapM :: forall (m :: * -> *) a b.
Monad m =>
(a -> m b) -> GraphQLResult a -> m (GraphQLResult b)
mapM :: forall (m :: * -> *) a b.
Monad m =>
(a -> m b) -> GraphQLResult a -> m (GraphQLResult b)
$csequence :: forall (m :: * -> *) a.
Monad m =>
GraphQLResult (m a) -> m (GraphQLResult a)
sequence :: forall (m :: * -> *) a.
Monad m =>
GraphQLResult (m a) -> m (GraphQLResult a)
Traversable)

instance (FromJSON r) => FromJSON (GraphQLResult r) where
  parseJSON :: Value -> Parser (GraphQLResult r)
parseJSON = String
-> (Object -> Parser (GraphQLResult r))
-> Value
-> Parser (GraphQLResult r)
forall a. String -> (Object -> Parser a) -> Value -> Parser a
withObject String
"GraphQLResult" ((Object -> Parser (GraphQLResult r))
 -> Value -> Parser (GraphQLResult r))
-> (Object -> Parser (GraphQLResult r))
-> Value
-> Parser (GraphQLResult r)
forall a b. (a -> b) -> a -> b
$ \Object
o ->
    [GraphQLError] -> Maybe r -> GraphQLResult r
forall r. [GraphQLError] -> Maybe r -> GraphQLResult r
GraphQLResult
      ([GraphQLError] -> Maybe r -> GraphQLResult r)
-> Parser [GraphQLError] -> Parser (Maybe r -> GraphQLResult r)
forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
<$> Object
o Object -> Key -> Parser (Maybe [GraphQLError])
forall a. FromJSON a => Object -> Key -> Parser (Maybe a)
.:? Key
"errors" Parser (Maybe [GraphQLError])
-> [GraphQLError] -> Parser [GraphQLError]
forall a. Parser (Maybe a) -> a -> Parser a
.!= []
      Parser (Maybe r -> GraphQLResult r)
-> Parser (Maybe r) -> Parser (GraphQLResult r)
forall a b. Parser (a -> b) -> Parser a -> Parser b
forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
<*> Object
o Object -> Key -> Parser (Maybe r)
forall a. FromJSON a => Object -> Key -> Parser (Maybe a)
.:? Key
"data"

-- | Get the errors in the @GraphQLResult@.
getErrors :: GraphQLResult r -> [GraphQLError]
getErrors :: forall r. GraphQLResult r -> [GraphQLError]
getErrors = GraphQLResult r -> [GraphQLError]
forall r. GraphQLResult r -> [GraphQLError]
resultErrors

-- | Get the result of the @GraphQLResult@.
getResult :: GraphQLResult r -> Maybe r
getResult :: forall r. GraphQLResult r -> Maybe r
getResult = GraphQLResult r -> Maybe r
forall r. GraphQLResult r -> Maybe r
resultResult