Safe Haskell	None
Language	Haskell2010

Data.Morpheus.Types

Description

GQL Types

Synopsis

gqlResolver :: m (Either String a) -> Resolver m a
gqlEffectResolver :: Monad m => [c] -> EffectT m c (Either String a) -> Resolver (EffectT m c) a
liftEffectResolver :: Monad m => [c] -> m (Either String a) -> Resolver (EffectT m c) a
type Resolver = ExceptT String
type ResM = Resolver IO
type EffectM = Resolver (EffectT IO Text)
class GQLType a where
- description :: Proxy a -> Text
class GQLScalar a where
- parseValue :: ScalarValue -> Either Text a
- serialize :: a -> ScalarValue
data GQLRequest = GQLRequest {
- query :: Key
- operationName :: Maybe Key
- variables :: Maybe (Map Key Value)
}
data GQLResponse
- = Data Value
- | Errors [JSONError]
newtype ID = ID {
- unpackID :: Text
}
data ScalarValue
- = Int Int
- | Float Float
- | String Text
- | Boolean Bool
data GQLRootResolver m a b c = GQLRootResolver {
- queryResolver :: ResolveT m a
- mutationResolver :: ResolveT (EffectT m Text) b
- subscriptionResolver :: ResolveT (EffectT m Text) c
}

Documentation

gqlResolver :: m (Either String a) -> Resolver m a Source #

GraphQL Resolver

gqlEffectResolver :: Monad m => [c] -> EffectT m c (Either String a) -> Resolver (EffectT m c) a Source #

GraphQL Resolver for mutation or subscription resolver , adds effect to normal resolver

liftEffectResolver :: Monad m => [c] -> m (Either String a) -> Resolver (EffectT m c) a Source #

lift Normal resolver inside Effect Resolver

type Resolver = ExceptT String Source #

Resolver Monad Transformer

type ResM = Resolver IO Source #

Monad IO resolver without GraphQL effect

type EffectM = Resolver (EffectT IO Text) Source #

Monad Resolver with GraphQL effects, used for communication between mutation and subscription

class GQLType a where Source #

GraphQL type, every graphQL type should have an instance of Generic and GQLType.

   ... deriving (Generic, GQLType)

if you want to add description

      ... deriving (Generic)

    instance GQLType ... where
      description = const "your description ..."

Minimal complete definition

Nothing

Methods

description :: Proxy a -> Text Source #

Instances

GQLType Bool Source #
Instance details Defined in Data.Morpheus.Types.GQLType Methods description :: Proxy Bool -> Text Source # __typeName :: Proxy Bool -> Text __typeFingerprint :: Proxy Bool -> DataFingerprint
GQLType Float Source #
Instance details Defined in Data.Morpheus.Types.GQLType Methods description :: Proxy Float -> Text Source # __typeName :: Proxy Float -> Text __typeFingerprint :: Proxy Float -> DataFingerprint
GQLType Int Source #
Instance details Defined in Data.Morpheus.Types.GQLType Methods description :: Proxy Int -> Text Source # __typeName :: Proxy Int -> Text __typeFingerprint :: Proxy Int -> DataFingerprint
GQLType Text Source #
Instance details Defined in Data.Morpheus.Types.GQLType Methods description :: Proxy Text -> Text Source # __typeName :: Proxy Text -> Text __typeFingerprint :: Proxy Text -> DataFingerprint
GQLType ID Source #
Instance details Defined in Data.Morpheus.Types.ID Methods description :: Proxy ID -> Text Source # __typeName :: Proxy ID -> Text __typeFingerprint :: Proxy ID -> DataFingerprint
GQLType a => GQLType [a] Source #
Instance details Defined in Data.Morpheus.Types.GQLType Methods description :: Proxy [a] -> Text Source # __typeName :: Proxy [a] -> Text __typeFingerprint :: Proxy [a] -> DataFingerprint
GQLType a => GQLType (Maybe a) Source #
Instance details Defined in Data.Morpheus.Types.GQLType Methods description :: Proxy (Maybe a) -> Text Source # __typeName :: Proxy (Maybe a) -> Text __typeFingerprint :: Proxy (Maybe a) -> DataFingerprint
GQLType a => GQLType (Set a) Source #
Instance details Defined in Data.Morpheus.Types.GQLType Methods description :: Proxy (Set a) -> Text Source # __typeName :: Proxy (Set a) -> Text __typeFingerprint :: Proxy (Set a) -> DataFingerprint
(Typeable a, Typeable b, GQLType a, GQLType b) => GQLType (a, b) Source #
Instance details Defined in Data.Morpheus.Types.GQLType Methods description :: Proxy (a, b) -> Text Source # __typeName :: Proxy (a, b) -> Text __typeFingerprint :: Proxy (a, b) -> DataFingerprint

class GQLScalar a where Source #

GraphQL Scalar

parseValue and serialize should be provided for every instances manually

Methods

parseValue :: ScalarValue -> Either Text a Source #

value parsing and validating

for exhaustive pattern matching should be handled all scalar types : ScalarValue, ScalarValue, ScalarValue, Boolean

invalid values can be reported with Left constructor :

  parseValue String _ = Left "" -- without error message
  -- or
  parseValue String _ = Left "Error Message"

serialize :: a -> ScalarValue Source #

serialization of haskell type into scalar value

Instances

GQLScalar Bool Source #
Instance details Defined in Data.Morpheus.Types.GQLScalar Methods parseValue :: ScalarValue -> Either Text Bool Source # serialize :: Bool -> ScalarValue Source # scalarValidator :: Proxy Bool -> DataValidator
GQLScalar Float Source #
Instance details Defined in Data.Morpheus.Types.GQLScalar Methods parseValue :: ScalarValue -> Either Text Float Source # serialize :: Float -> ScalarValue Source # scalarValidator :: Proxy Float -> DataValidator
GQLScalar Int Source #
Instance details Defined in Data.Morpheus.Types.GQLScalar Methods parseValue :: ScalarValue -> Either Text Int Source # serialize :: Int -> ScalarValue Source # scalarValidator :: Proxy Int -> DataValidator
GQLScalar Text Source #
Instance details Defined in Data.Morpheus.Types.GQLScalar Methods parseValue :: ScalarValue -> Either Text Text Source # serialize :: Text -> ScalarValue Source # scalarValidator :: Proxy Text -> DataValidator
GQLScalar ID Source #
Instance details Defined in Data.Morpheus.Types.ID Methods parseValue :: ScalarValue -> Either Text ID Source # serialize :: ID -> ScalarValue Source # scalarValidator :: Proxy ID -> DataValidator

data GQLRequest Source #

GraphQL HTTP Request Body

Constructors

GQLRequest
Fields query :: Key operationName :: Maybe Key variables :: Maybe (Map Key Value)

Instances

Show GQLRequest Source #
Instance details Defined in Data.Morpheus.Types.IO Methods showsPrec :: Int -> GQLRequest -> ShowS # show :: GQLRequest -> String # showList :: [GQLRequest] -> ShowS #
Generic GQLRequest Source #
Instance details Defined in Data.Morpheus.Types.IO Associated Types type Rep GQLRequest :: Type -> Type # Methods from :: GQLRequest -> Rep GQLRequest x # to :: Rep GQLRequest x -> GQLRequest #
FromJSON GQLRequest Source #
Instance details Defined in Data.Morpheus.Types.IO Methods parseJSON :: Value -> Parser GQLRequest # parseJSONList :: Value -> Parser [GQLRequest] #
Interpreter (GQLRequest -> m GQLResponse) m Source #
Instance details Defined in Data.Morpheus.Interpreter Methods interpreter :: (Monad m, RootResCon m a b c) => GQLRootResolver m a b c -> GQLRequest -> m GQLResponse Source #
type Rep GQLRequest Source #
Instance details Defined in Data.Morpheus.Types.IO type Rep GQLRequest

data GQLResponse Source #

GraphQL Response

Constructors

Data Value
Errors [JSONError]

Instances

Show GQLResponse Source #
Instance details Defined in Data.Morpheus.Types.IO Methods showsPrec :: Int -> GQLResponse -> ShowS # show :: GQLResponse -> String # showList :: [GQLResponse] -> ShowS #
Generic GQLResponse Source #
Instance details Defined in Data.Morpheus.Types.IO Associated Types type Rep GQLResponse :: Type -> Type # Methods from :: GQLResponse -> Rep GQLResponse x # to :: Rep GQLResponse x -> GQLResponse #
ToJSON GQLResponse Source #
Instance details Defined in Data.Morpheus.Types.IO Methods toJSON :: GQLResponse -> Value # toEncoding :: GQLResponse -> Encoding # toJSONList :: [GQLResponse] -> Value # toEncodingList :: [GQLResponse] -> Encoding #
Interpreter (GQLRequest -> m GQLResponse) m Source #
Instance details Defined in Data.Morpheus.Interpreter Methods interpreter :: (Monad m, RootResCon m a b c) => GQLRootResolver m a b c -> GQLRequest -> m GQLResponse Source #
type Rep GQLResponse Source #
Instance details Defined in Data.Morpheus.Types.IO type Rep GQLResponse

newtype ID Source #

default GraphQL type, parses only ScalarValue and ScalarValue values, serialized always as ScalarValue

Constructors

ID
Fields unpackID :: Text

Instances

Generic ID Source #
Instance details Defined in Data.Morpheus.Types.ID Associated Types type Rep ID :: Type -> Type # Methods from :: ID -> Rep ID x # to :: Rep ID x -> ID #
GQLScalar ID Source #
Instance details Defined in Data.Morpheus.Types.ID Methods parseValue :: ScalarValue -> Either Text ID Source # serialize :: ID -> ScalarValue Source # scalarValidator :: Proxy ID -> DataValidator
GQLType ID Source #
Instance details Defined in Data.Morpheus.Types.ID Methods description :: Proxy ID -> Text Source # __typeName :: Proxy ID -> Text __typeFingerprint :: Proxy ID -> DataFingerprint
type Rep ID Source #
Instance details Defined in Data.Morpheus.Types.ID type Rep ID = D1 (MetaData "ID" "Data.Morpheus.Types.ID" "morpheus-graphql-0.1.1-F6U2uttoPzk7pexbpDDUMQ" True) (C1 (MetaCons "ID" PrefixI True) (S1 (MetaSel (Just "unpackID") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Text)))
type KIND ID Source #
Instance details Defined in Data.Morpheus.Types.ID type KIND ID = SCALAR

data ScalarValue Source #

Primitive Values for GQLScalar: ScalarValue, ScalarValue, ScalarValue, Boolean. for performance reason type Text represents GraphQl ScalarValue value

Constructors

Int Int
Float Float
String Text
Boolean Bool

Instances

Show ScalarValue Source #
Instance details Defined in Data.Morpheus.Types.Internal.Value Methods showsPrec :: Int -> ScalarValue -> ShowS # show :: ScalarValue -> String # showList :: [ScalarValue] -> ShowS #
Generic ScalarValue Source #
Instance details Defined in Data.Morpheus.Types.Internal.Value Associated Types type Rep ScalarValue :: Type -> Type # Methods from :: ScalarValue -> Rep ScalarValue x # to :: Rep ScalarValue x -> ScalarValue #
ToJSON ScalarValue Source #
Instance details Defined in Data.Morpheus.Types.Internal.Value Methods toJSON :: ScalarValue -> Value # toEncoding :: ScalarValue -> Encoding # toJSONList :: [ScalarValue] -> Value # toEncodingList :: [ScalarValue] -> Encoding #
type Rep ScalarValue Source #
Instance details Defined in Data.Morpheus.Types.Internal.Value type Rep ScalarValue = D1 (MetaData "ScalarValue" "Data.Morpheus.Types.Internal.Value" "morpheus-graphql-0.1.1-F6U2uttoPzk7pexbpDDUMQ" False) ((C1 (MetaCons "Int" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Int)) :+: C1 (MetaCons "Float" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Float))) :+: (C1 (MetaCons "String" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Text)) :+: C1 (MetaCons "Boolean" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Bool))))

data GQLRootResolver m a b c Source #

GraphQL Root resolver, also the interpreter generates a GQL schema from it.

queryResolver is required, mutationResolver and subscriptionResolver are optional, if your schema does not supports mutation or subscription , you acn use () for it.

Constructors

GQLRootResolver
Fields queryResolver :: ResolveT m a mutationResolver :: ResolveT (EffectT m Text) b subscriptionResolver :: ResolveT (EffectT m Text) c