GraphQL.API

Use this to define your GraphQL schema with Haskell types.

Documentation

data Object (name :: Symbol) (interfaces :: [Type]) (fields :: [Type])

Instances

(RunFields m (RunFieldsType m fields), HasObjectDefinition (Object typeName interfaces fields), Monad m) => HasResolver m (Object typeName interfaces fields :: Type)

Defined in GraphQL.Internal.Resolver

Associated Types

type Handler m (Object typeName interfaces fields) :: Type

Methods

resolve :: Handler m (Object typeName interfaces fields) -> Maybe (SelectionSetByType Value) -> m (Result Value)

(KnownSymbol ks, HasInterfaceDefinitions is, HasFieldDefinitions ts) => HasAnnotatedType (Object ks is ts :: Type)

Defined in GraphQL.Internal.API

Methods

getAnnotatedType :: Either SchemaError (AnnotatedType GType)

(KnownSymbol ks, HasInterfaceDefinitions is, HasFieldDefinitions fields) => HasObjectDefinition (Object ks is fields :: Type)

Defined in GraphQL.Internal.API

Methods

getDefinition :: Either SchemaError ObjectTypeDefinition

type Handler m (Object typeName interfaces fields :: Type)

Defined in GraphQL.Internal.Resolver

type Handler m (Object typeName interfaces fields :: Type)

data Field (name :: Symbol) (fieldType :: Type)

data Argument (name :: Symbol) (argType :: Type)

data Union (name :: Symbol) (types :: [Type])

Instances

(Monad m, KnownSymbol unionName, RunUnion m (Union unionName objects) objects) => HasResolver m (Union unionName objects :: Type)

Defined in GraphQL.Internal.Resolver

Associated Types

type Handler m (Union unionName objects) :: Type

Methods

resolve :: Handler m (Union unionName objects) -> Maybe (SelectionSetByType Value) -> m (Result Value)

(KnownSymbol ks, HasUnionTypeObjectTypeDefinitions as) => HasAnnotatedType (Union ks as :: Type)

Defined in GraphQL.Internal.API

Methods

getAnnotatedType :: Either SchemaError (AnnotatedType GType)

type Handler m (Union unionName objects :: Type)

Defined in GraphQL.Internal.Resolver

type Handler m (Union unionName objects :: Type)

data List (elemType :: Type)

Instances

HasAnnotatedInputType t => HasAnnotatedInputType (List t)

Defined in GraphQL.Internal.API

Methods

getAnnotatedInputType :: Either SchemaError (AnnotatedType InputType)

(Monad m, Applicative m, HasResolver m hg) => HasResolver m (List hg :: Type)

Defined in GraphQL.Internal.Resolver

Associated Types

type Handler m (List hg) :: Type

Methods

resolve :: Handler m (List hg) -> Maybe (SelectionSetByType Value) -> m (Result Value)

HasAnnotatedType t => HasAnnotatedType (List t :: Type)

Defined in GraphQL.Internal.API

Methods

getAnnotatedType :: Either SchemaError (AnnotatedType GType)

type Handler m (List hg :: Type)

Defined in GraphQL.Internal.Resolver

type Handler m (List hg :: Type)

data Enum (name :: Symbol) (values :: Type)

Instances

(Applicative m, GraphQLEnum enum) => HasResolver m (Enum ksN enum :: Type)

Defined in GraphQL.Internal.Resolver

Associated Types

type Handler m (Enum ksN enum) :: Type

Methods

resolve :: Handler m (Enum ksN enum) -> Maybe (SelectionSetByType Value) -> m (Result Value)

(KnownSymbol ks, GraphQLEnum enum) => HasAnnotatedType (Enum ks enum :: Type)

Defined in GraphQL.Internal.API

Methods

getAnnotatedType :: Either SchemaError (AnnotatedType GType)

(KnownSymbol ks, GraphQLEnum enum) => HasAnnotatedInputType (Enum ks enum)

Defined in GraphQL.Internal.API

Methods

getAnnotatedInputType :: Either SchemaError (AnnotatedType InputType)

type Handler m (Enum ksN enum :: Type)

Defined in GraphQL.Internal.Resolver

type Handler m (Enum ksN enum :: Type)

class GraphQLEnum a where

For each enum type we need 1) a list of all possible values 2) a way to serialise and 3) deserialise.

TODO: Update this comment to explain what a GraphQLEnum is, why you might want an instance, and any laws that apply to method relations.

Minimal complete definition

Nothing

Methods

enumValues :: [Either NameError Name]

enumValues :: (Generic a, GenericEnumValues (Rep a)) => [Either NameError Name]

enumFromValue :: Name -> Either Text a

enumFromValue :: (Generic a, GenericEnumValues (Rep a)) => Name -> Either Text a

enumToValue :: a -> Name

enumToValue :: (Generic a, GenericEnumValues (Rep a)) => a -> Name

data Interface (name :: Symbol) (fields :: [Type])

data a :> b infixr 8

Argument operator. Can only be used with Field.

Say we have a Company object that has a field that shows whether someone is an employee, e.g.

  type Company {
    hasEmployee(employeeName: String!): String!
  }

Then we might represent that as:

>>> type Company = Object "Company" '[] '[Argument "employeeName" Text :> Field "hasEmployee" Bool]

For multiple arguments, simply chain them together with :>, ending finally with Field. e.g.

  Argument "foo" String :> Argument "bar" Int :> Field "qux" Int

Constructors

a :> b infixr 8

class Defaultable a where

Specify a default value for a type in a GraphQL schema.

GraphQL schema can have default values in certain places. For example, arguments to fields can have default values. Because we cannot lift arbitrary values to the type level, we need some way of getting at those values. This typeclass provides the means.

To specify a default, implement this typeclass.

The default implementation is to say that there *is* no default for this type.

Minimal complete definition

Nothing

Methods

defaultFor :: Name -> Maybe a

defaultFor returns the value to be used when no value has been given.

Instances

Defaultable Bool

Defined in GraphQL.Internal.API

Methods

defaultFor :: Name -> Maybe Bool

Defaultable Double

Defined in GraphQL.Internal.API

Methods

defaultFor :: Name -> Maybe Double

Defaultable Int32

Defined in GraphQL.Internal.API

Methods

defaultFor :: Name -> Maybe Int32

Defaultable Text

Defined in GraphQL.Internal.API

Methods

defaultFor :: Name -> Maybe Text

Defaultable (Maybe a)

Defined in GraphQL.Internal.API

Methods

defaultFor :: Name -> Maybe (Maybe a)

class HasObjectDefinition a where

Methods

getDefinition :: Either SchemaError ObjectTypeDefinition

Instances

(KnownSymbol ks, HasInterfaceDefinitions is, HasFieldDefinitions fields) => HasObjectDefinition (Object ks is fields :: Type)

Defined in GraphQL.Internal.API

Methods

getDefinition :: Either SchemaError ObjectTypeDefinition

class HasAnnotatedInputType a where

Minimal complete definition

Nothing

Methods

getAnnotatedInputType :: Either SchemaError (AnnotatedType InputType)

getAnnotatedInputType :: (Generic a, GenericAnnotatedInputType (Rep a)) => Either SchemaError (AnnotatedType InputType)

Instances

HasAnnotatedInputType Bool

Defined in GraphQL.Internal.API

Methods

getAnnotatedInputType :: Either SchemaError (AnnotatedType InputType)

HasAnnotatedInputType Double

Defined in GraphQL.Internal.API

Methods

getAnnotatedInputType :: Either SchemaError (AnnotatedType InputType)

HasAnnotatedInputType Float

Defined in GraphQL.Internal.API

Methods

getAnnotatedInputType :: Either SchemaError (AnnotatedType InputType)

HasAnnotatedInputType Int

Defined in GraphQL.Internal.API

Methods

getAnnotatedInputType :: Either SchemaError (AnnotatedType InputType)

HasAnnotatedInputType Int32

Defined in GraphQL.Internal.API

Methods

getAnnotatedInputType :: Either SchemaError (AnnotatedType InputType)

HasAnnotatedInputType Text

Defined in GraphQL.Internal.API

Methods

getAnnotatedInputType :: Either SchemaError (AnnotatedType InputType)

HasAnnotatedInputType a => HasAnnotatedInputType (Maybe a)

Defined in GraphQL.Internal.API

Methods

getAnnotatedInputType :: Either SchemaError (AnnotatedType InputType)

HasAnnotatedInputType t => HasAnnotatedInputType (List t)

Defined in GraphQL.Internal.API

Methods

getAnnotatedInputType :: Either SchemaError (AnnotatedType InputType)

(KnownSymbol ks, GraphQLEnum enum) => HasAnnotatedInputType (Enum ks enum)

Defined in GraphQL.Internal.API

Methods

getAnnotatedInputType :: Either SchemaError (AnnotatedType InputType)

data SchemaError

The type-level schema was somehow invalid.

Constructors

NameError NameError

EmptyFieldList

EmptyUnion

Instances

Eq SchemaError

Defined in GraphQL.Internal.API

Methods

(==) :: SchemaError -> SchemaError -> Bool

(/=) :: SchemaError -> SchemaError -> Bool

Show SchemaError

Defined in GraphQL.Internal.API

Methods

showsPrec :: Int -> SchemaError -> ShowS

show :: SchemaError -> String

showList :: [SchemaError] -> ShowS

GraphQLError SchemaError

Defined in GraphQL.Internal.API

Methods

formatError :: SchemaError -> Text

toError :: SchemaError -> Error