-- Hoogle documentation, generated by Haddock
-- See Hoogle, http://www.haskell.org/hoogle/


-- | Morpheus GraphQL
--   
--   Build GraphQL APIs with your favourite functional language!
@package morpheus-graphql
@version 0.24.3


-- | Build GraphQL APIs with your favorite functional language!
module Data.Morpheus

-- | main query processor and resolver
interpreter :: forall a b m e (query :: (Type -> Type) -> Type) (mut :: (Type -> Type) -> Type) (sub :: (Type -> Type) -> Type). (MapAPI a b, RootResolverConstraint m e query mut sub) => RootResolver m e query mut sub -> a -> m b
debugInterpreter :: forall a b m e (query :: (Type -> Type) -> Type) (mut :: (Type -> Type) -> Type) (sub :: (Type -> Type) -> Type). (MapAPI a b, RootResolverConstraint m e query mut sub) => RootResolver m e query mut sub -> a -> m b
data App event (m :: Type -> Type)
deriveApp :: DeriveApp f m event qu mu su => f m event qu mu su -> App event m
runApp :: (MapAPI a b, Monad m) => App e m -> a -> m b
withDebugger :: forall e (m :: Type -> Type). App e m -> App e m
httpPlayground :: ByteString

-- | normal morpheus server validates schema at runtime (after the schema
--   derivation). this method allows you to validate it at compile time.
compileTimeSchemaValidation :: forall {k} event (m :: Type -> Type) (qu :: (Type -> Type) -> Type) (mu :: (Type -> Type) -> Type) (su :: (Type -> Type) -> Type) proxy (root :: (Type -> Type) -> Type -> ((Type -> Type) -> Type) -> ((Type -> Type) -> Type) -> ((Type -> Type) -> Type) -> k). SchemaConstraints event m qu mu su => proxy (root m event qu mu su) -> Q Exp


-- | associating types to GraphQL Kinds
module Data.Morpheus.Kind

-- | GraphQL Scalar: Int, Float, String, Boolean or any user defined custom
--   Scalar type
type SCALAR = 'SCALAR

-- | <i>Deprecated: use: deriving(GQLType), will be automatically
--   inferred</i>
type OBJECT = TYPE

-- | <i>Deprecated: use: deriving(GQLType), will be automatically
--   inferred</i>
type ENUM = TYPE

-- | GraphQL Arrays , Resolvers and NonNull fields
type WRAPPER = 'WRAPPER

-- | <i>Deprecated: use: deriving(GQLType), IMPORTANT: only types with
--   <a>constructor name</a><a>name</a> will sustain their form, other
--   union constructors will be wrapped inside an new object</i>
type UNION = TYPE

-- | <i>Deprecated: use: deriving(GQLType), will be automatically
--   inferred</i>
type INPUT_OBJECT = TYPE
data DerivingKind
SCALAR :: DerivingKind
TYPE :: DerivingKind
WRAPPER :: DerivingKind
CUSTOM :: DerivingKind

-- | <i>Deprecated: use: DerivingKind</i>
type GQL_KIND = DerivingKind

-- | <i>Deprecated: use: deriving(GQLType), will be automatically
--   inferred</i>
type OUTPUT = TYPE

-- | <i>Deprecated: use: deriving(GQLType), will be automatically
--   inferred</i>
type INPUT = TYPE

-- | <i>Deprecated: use: deriving(GQLType), will be automatically
--   inferred</i>
type INTERFACE = TYPE

-- | GraphQL input, type, union , enum
type TYPE = 'TYPE
type CUSTOM = 'CUSTOM

module Data.Morpheus.NamedResolvers
class ToJSON Dep a => ResolveNamed (m :: Type -> Type) a where {
    type family Dep a;
}
resolveNamed :: ResolveNamed m a => Dep a -> m a
data NamedResolverT (m :: Type -> Type) a
[Ref] :: forall (m :: Type -> Type) a. ResolveNamed m a => m (Dep a) -> NamedResolverT m a
[Refs] :: forall (m :: Type -> Type) a1. ResolveNamed m a1 => m [Dep a1] -> NamedResolverT m [a1]
[Value] :: forall (m :: Type -> Type) a. m a -> NamedResolverT m a
resolve :: forall m a b. (ResolveByType (RES_TYPE a b) m a b, Monad m) => m a -> NamedResolverT m b


-- | GQL Types
module Data.Morpheus.Types

-- | GraphQL type, every graphQL type should have an instance of
--   <a>Generic</a> and <a>GQLType</a>.
--   
--   <pre>
--   ... deriving (Generic, GQLType)
--   
--   </pre>
--   
--   if you want to add description
--   
--   <pre>
--     ... deriving (Generic)
--   
--   instance GQLType ... where
--     description = const "your description ..."
--   
--   </pre>
class GQLType a where {
    type family KIND a :: DerivingKind;
    type KIND a = TYPE;
}

-- | A description of the type.
--   
--   Used for documentation in the GraphQL schema.
description :: GQLType a => f a -> Maybe Text
directives :: GQLType a => f a -> DirectiveUsages

-- | A dictionary of descriptions for fields, keyed on field name.
--   
--   Used for documentation in the GraphQL schema.
getDescriptions :: GQLType a => f a -> Map Text Description
typeOptions :: GQLType a => f a -> GQLTypeOptions -> GQLTypeOptions
getDirectives :: GQLType a => f a -> Map Text (Directives CONST)
defaultValues :: GQLType a => f a -> Map Text (Value CONST)

-- | GraphQL Scalar Serializer
class EncodeScalar a
encodeScalar :: EncodeScalar a => a -> ScalarValue

-- | GraphQL Wrapper Serializer
class EncodeWrapper (wrapper :: Type -> Type)
encodeWrapper :: (EncodeWrapper wrapper, Monad m) => (a -> m (ResolverValue m)) -> wrapper a -> m (ResolverValue m)

-- | GraphQL Scalar parser
class DecodeScalar a
decodeScalar :: DecodeScalar a => ScalarValue -> Either Text a

-- | GraphQL Wrapper Deserializer
class DecodeWrapper (f :: Type -> Type)
decodeWrapper :: (DecodeWrapper f, Monad m, DecodeWrapperConstraint f a) => (ValidValue -> m a) -> ValidValue -> ExceptT GQLError m (f a)

-- | GraphQL HTTP Request Body
data GQLRequest
GQLRequest :: Maybe FieldName -> Text -> Maybe Value -> GQLRequest
[operationName] :: GQLRequest -> Maybe FieldName
[query] :: GQLRequest -> Text
[variables] :: GQLRequest -> Maybe Value

-- | GraphQL Response
data GQLResponse
Data :: ValidValue -> GQLResponse
Errors :: [GQLError] -> GQLResponse

-- | default GraphQL type, parses only <a>ScalarValue</a> and
--   <a>ScalarValue</a> values, serialized always as <a>ScalarValue</a>
newtype ID
ID :: Text -> ID
[unpackID] :: ID -> Text

-- | Primitive Values for GQLScalar: <a>ScalarValue</a>,
--   <a>ScalarValue</a>, <a>ScalarValue</a>, <a>Boolean</a>. for
--   performance reason type <a>Text</a> represents GraphQl
--   <a>ScalarValue</a> value
data ScalarValue
Int :: Int -> ScalarValue
Float :: Double -> ScalarValue
String :: Text -> ScalarValue
Boolean :: Bool -> ScalarValue
Value :: Value -> ScalarValue

-- | GraphQL Root resolver, also the interpreter generates a GQL schema
--   from it. <a>queryResolver</a> is required, <a>mutationResolver</a> and
--   <a>subscriptionResolver</a> are optional, if your schema does not
--   supports <b>mutation</b> or <b>subscription</b> , you can use
--   <b>()</b> for it.
data RootResolver (m :: Type -> Type) event (query :: Type -> Type -> Type) (mutation :: Type -> Type -> Type) (subscription :: Type -> Type -> Type)
RootResolver :: query (Resolver QUERY event m) -> mutation (Resolver MUTATION event m) -> subscription (Resolver SUBSCRIPTION event m) -> RootResolver (m :: Type -> Type) event (query :: (Type -> Type) -> Type) (mutation :: (Type -> Type) -> Type) (subscription :: (Type -> Type) -> Type)
[queryResolver] :: RootResolver (m :: Type -> Type) event (query :: (Type -> Type) -> Type) (mutation :: (Type -> Type) -> Type) (subscription :: (Type -> Type) -> Type) -> query (Resolver QUERY event m)
[mutationResolver] :: RootResolver (m :: Type -> Type) event (query :: (Type -> Type) -> Type) (mutation :: (Type -> Type) -> Type) (subscription :: (Type -> Type) -> Type) -> mutation (Resolver MUTATION event m)
[subscriptionResolver] :: RootResolver (m :: Type -> Type) event (query :: (Type -> Type) -> Type) (mutation :: (Type -> Type) -> Type) (subscription :: (Type -> Type) -> Type) -> subscription (Resolver SUBSCRIPTION event m)
constRes :: forall (o :: OperationType) (m :: Type -> Type) b a e. (WithOperation o, Monad m) => b -> a -> Resolver o e m b
constMutRes :: Monad m => [e] -> a -> args -> ResolverM e m a
data Undefined (m :: Type -> Type)
data Resolver (o :: OperationType) event (m :: Type -> Type) value
type QUERY = 'Query
type MUTATION = 'Mutation
type SUBSCRIPTION = 'Subscription

-- | Lift a computation from the argument monad to the constructed monad.
lift :: (MonadTrans t, Monad m) => m a -> t m a
liftEither :: (MonadTrans t, Monad (t m), MonadError GQLError (t m)) => Monad m => m (Either String a) -> t m a

-- | <i>Deprecated: use "fail" from <a>MonadFail</a></i>
failRes :: (Monad m, WithOperation o) => String -> Resolver o e m a
type WithOperation (o :: OperationType) = LiftOperation o
publish :: forall (m :: Type -> Type) e. Monad m => [e] -> Resolver MUTATION e m ()
subscribe :: forall (m :: Type -> Type) e a. Monad m => Channel e -> Resolver QUERY e m (e -> Resolver SUBSCRIPTION e m a) -> SubscriptionField (Resolver SUBSCRIPTION e m a)

-- | A function to return the internal <a>ResolverContext</a> within a
--   resolver's monad. Using the <a>ResolverContext</a> itself is unsafe
--   because it exposes internal structures of the AST, but you can use the
--   <a>Data.Morpheus.Types.SelectionTree</a> typeClass to manipulate the
--   internal AST with a safe interface.
unsafeInternalContext :: forall (m :: Type -> Type) (o :: OperationType) e. (Monad m, LiftOperation o) => Resolver o e m ResolverContext
data ResolverContext
ResolverContext :: Selection VALID -> Schema VALID -> Operation VALID -> Config -> TypeDefinition ANY VALID -> ResolverContext
[currentSelection] :: ResolverContext -> Selection VALID
[schema] :: ResolverContext -> Schema VALID
[operation] :: ResolverContext -> Operation VALID
[config] :: ResolverContext -> Config
[currentType] :: ResolverContext -> TypeDefinition ANY VALID
type ResolverO (o :: OperationType) e (m :: Type -> Type) (a :: k) = Flexible Resolver o e m a
type ComposedResolver (o :: OperationType) e (m :: Type -> Type) (f :: Type -> Type) (a :: k) = Composed Resolver o e m f a
type ResolverQ e (m :: Type -> Type) (a :: k) = Flexible Resolver QUERY e m a
type ResolverM e (m :: Type -> Type) (a :: k) = Flexible Resolver MUTATION e m a
type ResolverS e (m :: Type -> Type) (a :: k) = Flexible Resolver SUBSCRIPTION e m a

-- | <i>Deprecated: use ResolverQ</i>
type ResolveQ e m a = ResolverQ e m a

-- | <i>Deprecated: use ResolverM</i>
type ResolveM e m a = ResolverM e m a

-- | <i>Deprecated: use ResolverS</i>
type ResolveS e m a = ResolverS e m a

-- | <i>Deprecated: use ResolverQ</i>
type Res = Resolver QUERY

-- | <i>Deprecated: use ResolverM</i>
type MutRes = Resolver MUTATION

-- | <i>Deprecated: use ResolverS</i>
type SubRes = Resolver SUBSCRIPTION

-- | <i>Deprecated: use ResolverQ</i>
type IORes e = Res e IO

-- | <i>Deprecated: use ResolverM</i>
type IOMutRes e = MutRes e IO

-- | <i>Deprecated: use ResolverS</i>
type IOSubRes e = SubRes e IO
data SubscriptionField a
data App event (m :: Type -> Type)
class RenderGQL a
render :: RenderGQL a => a -> ByteString
data TypeGuard interface union
ResolveInterface :: interface -> TypeGuard interface union
ResolveType :: union -> TypeGuard interface union
newtype Arg (name :: Symbol) a
Arg :: a -> Arg (name :: Symbol) a
[argValue] :: Arg (name :: Symbol) a -> a
data NamedResolvers (m :: Type -> Type) event (qu :: Type -> Type -> Type) (mu :: Type -> Type -> Type) (su :: Type -> Type -> Type)
NamedResolvers :: NamedResolvers (m :: Type -> Type) event (qu :: (Type -> Type) -> Type) (mu :: (Type -> Type) -> Type) (su :: (Type -> Type) -> Type)

-- | Options that specify how to map GraphQL field, type, and constructor
--   names to and from their Haskell equivalent.
--   
--   Options can be set using record syntax on <tt>defaultOptions</tt> with
--   the fields below.
data GQLTypeOptions

-- | Default encoding <a>GQLTypeOptions</a>:
--   
--   <pre>
--   <a>GQLTypeOptions</a>
--     { <a>fieldLabelModifier</a>      = id
--     , <a>constructorTagModifier</a>  = id
--     , <a>typeNameModifier</a>        = const id
--     }
--   </pre>
defaultTypeOptions :: GQLTypeOptions

-- | Function applied to field labels. Handy for removing common record
--   prefixes for example.
fieldLabelModifier :: GQLTypeOptions -> String -> String

-- | Function applied to constructor tags.
constructorTagModifier :: GQLTypeOptions -> String -> String

-- | Construct a new type name depending on whether it is an input, and
--   being given the original type name.
typeNameModifier :: GQLTypeOptions -> Bool -> String -> String
defaultRootResolver :: forall (m :: Type -> Type) event. RootResolver m event Undefined Undefined Undefined

-- | a custom GraphQL directive for adding or removing of prefixes
data Prefixes
Prefixes :: Text -> Text -> Prefixes
[addPrefix] :: Prefixes -> Text
[removePrefix] :: Prefixes -> Text
class VisitType a

-- | Construct a new type name depending on whether it is an input, and
--   being given the original type name.
visitTypeName :: VisitType a => a -> Bool -> Text -> Text
visitTypeDescription :: VisitType a => a -> Maybe Text -> Maybe Text

-- | Function applied to field labels. Handy for removing common record
--   prefixes for example.
visitFieldNames :: VisitType a => a -> Text -> Text

-- | Function applied to enum values Handy for removing common enum
--   prefixes for example.
visitEnumNames :: VisitType a => a -> Text -> Text
class VisitField a
visitFieldName :: VisitField a => a -> Text -> Text
visitFieldDescription :: VisitField a => a -> Maybe Text -> Maybe Text
newtype Describe
Describe :: Text -> Describe
[text] :: Describe -> Text
class VisitEnum a
visitEnumName :: VisitEnum a => a -> Text -> Text
visitEnumDescription :: VisitEnum a => a -> Maybe Text -> Maybe Text
typeDirective :: TypeDirectiveConstraint a => a -> DirectiveUsages
fieldDirective :: TypeDirectiveConstraint a => FieldName -> a -> DirectiveUsages
enumDirective :: TypeDirectiveConstraint a => TypeName -> a -> DirectiveUsages
class (Typeable a, WITH_VISITOR a VISIT_TYPE TYPE_VISITOR_KIND, WITH_VISITOR a VISIT_FIELD FIELD_VISITOR_KIND, WITH_VISITOR a VISIT_ENUM ENUM_VISITOR_KIND) => GQLDirective a where {
    type family DIRECTIVE_LOCATIONS a :: [DirectiveLocation];
}
excludeFromSchema :: GQLDirective a => f a -> Bool
newtype Deprecated
Deprecated :: Maybe Text -> Deprecated
[reason] :: Deprecated -> Maybe Text
dropNamespaceOptions :: TypeKind -> Text -> GQLTypeOptions -> GQLTypeOptions
newtype DropNamespace
DropNamespace :: Text -> DropNamespace
[dropNamespace] :: DropNamespace -> Text

-- | a custom GraphQL directive for adding or removing of prefixes
newtype Rename
Rename :: Text -> Rename
[newName] :: Rename -> Text

module Data.Morpheus.Document

-- | <i>Deprecated: use Data.Morpheus.Server.printSchema</i>
toGraphQLDocument :: RootResolverConstraint m event query mut sub => proxy (RootResolver m event query mut sub) -> ByteString
gqlDocument :: QuasiQuoter
importGQLDocument :: FilePath -> Q [Dec]
importGQLDocumentWithNamespace :: FilePath -> Q [Dec]
type RootResolverConstraint (m :: Type -> Type) e (query :: Type -> Type -> Type) (mutation :: Type -> Type -> Type) (subscription :: Type -> Type -> Type) = (EncodeConstraints e m query mutation subscription, SchemaConstraints e m query mutation subscription, Monad m)