-- 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.27.2


-- | 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 {k1} {k2} {k3} (qu :: (Type -> Type) -> Type) (mu :: (Type -> Type) -> Type) (su :: (Type -> Type) -> Type) proxy (root :: k2 -> k3 -> ((Type -> Type) -> Type) -> ((Type -> Type) -> Type) -> ((Type -> Type) -> Type) -> k1) (m :: k2) (event :: k3). SCHEMA qu mu su => proxy (root m event qu mu su) -> Q Exp

module Data.Morpheus.Document
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) = (DERIVE_RESOLVERS Resolver QUERY e m query mutation subscription, SCHEMA query mutation subscription, Monad m)


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

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

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

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

module Data.Morpheus.NamedResolvers
class ToJSON Dependency a => ResolveNamed (m :: Type -> Type) a where {
    type family Dep a;
}
resolveBatched :: ResolveNamed m a => [Dependency a] -> m [Maybe a]
resolveNamed :: ResolveNamed m a => Dependency a -> m a
data NamedResolverT (m :: Type -> Type) a
[NamedResolverT] :: forall (m :: Type -> Type) a. ResolveNamed m (Target a) => m (NamedRef a) -> NamedResolverT m a
resolve :: ResolveNamed m (Target a) => m (NamedRef a) -> NamedResolverT m a
useBatched :: (ResolveNamed m a, MonadError GQLError m) => Dependency a -> m a


-- | 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
--      directives _ = typeDirective (Describe "some text")
--   
--   </pre>
class GQLType a where {
    type family KIND a :: DerivingKind;
    type KIND a = TYPE;
}
directives :: GQLType a => f a -> DirectiveUsages

-- | 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 :: MonadResolver m => b -> a -> m b
data Undefined (m :: Type -> Type)
data Resolver (o :: OperationType) event (m :: Type -> Type) value
type QUERY = 'OPERATION_QUERY
type MUTATION = 'OPERATION_MUTATION
type SUBSCRIPTION = 'OPERATION_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
type WithOperation (o :: OperationType) = LiftOperation o
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) = ResolverO QUERY e m a
type ResolverM e (m :: Type -> Type) (a :: k) = ResolverO MUTATION e m a
type ResolverS e (m :: Type -> Type) (a :: k) = ResolverO SUBSCRIPTION e m a
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)
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
visitFieldDefaultValue :: VisitField a => a -> Maybe (Value CONST) -> Maybe (Value CONST)
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 :: forall a (gql :: Type -> Constraint) (args :: Type -> Constraint). (GQLDirective a, gql a, args a) => a -> GDirectiveUsages gql args
fieldDirective :: forall a (gql :: Type -> Constraint) (args :: Type -> Constraint). (GQLDirective a, gql a, args a) => FieldName -> a -> GDirectiveUsages gql args
enumDirective :: forall a (gql :: Type -> Constraint) (args :: Type -> Constraint). (GQLDirective a, gql a, args a) => TypeName -> a -> GDirectiveUsages gql args
class (ToLocations DIRECTIVE_LOCATIONS a, 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
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
newtype DefaultValue
DefaultValue :: Value CONST -> DefaultValue
[defaultValue] :: DefaultValue -> Value CONST
data GQLError

-- | The strategy of combining computations that can throw exceptions by
--   bypassing bound functions from the point an exception is thrown to the
--   point that it is handled.
--   
--   Is parameterized over the type of error information and the monad type
--   constructor. It is common to use <tt><a>Either</a> String</tt> as the
--   monad type constructor for an error monad in which error descriptions
--   take the form of strings. In that case and many other common cases the
--   resulting monad is already defined as an instance of the
--   <a>MonadError</a> class. You can also define your own error type
--   and/or use a monad type constructor other than <tt><a>Either</a>
--   <tt>String</tt></tt> or <tt><a>Either</a> <tt>IOError</tt></tt>. In
--   these cases you will have to explicitly define instances of the
--   <a>MonadError</a> class. (If you are using the deprecated
--   <a>Control.Monad.Error</a> or <a>Control.Monad.Trans.Error</a>, you
--   may also have to define an <a>Error</a> instance.)
class Monad m => MonadError e (m :: Type -> Type) | m -> e
data DirectiveLocation
LOCATION_QUERY :: DirectiveLocation
LOCATION_MUTATION :: DirectiveLocation
LOCATION_SUBSCRIPTION :: DirectiveLocation
LOCATION_FIELD :: DirectiveLocation
LOCATION_FRAGMENT_DEFINITION :: DirectiveLocation
LOCATION_FRAGMENT_SPREAD :: DirectiveLocation
LOCATION_INLINE_FRAGMENT :: DirectiveLocation
LOCATION_SCHEMA :: DirectiveLocation
LOCATION_SCALAR :: DirectiveLocation
LOCATION_OBJECT :: DirectiveLocation
LOCATION_FIELD_DEFINITION :: DirectiveLocation
LOCATION_ARGUMENT_DEFINITION :: DirectiveLocation
LOCATION_INTERFACE :: DirectiveLocation
LOCATION_UNION :: DirectiveLocation
LOCATION_ENUM :: DirectiveLocation
LOCATION_ENUM_VALUE :: DirectiveLocation
LOCATION_INPUT_OBJECT :: DirectiveLocation
LOCATION_INPUT_FIELD_DEFINITION :: DirectiveLocation
class (Monad m, MonadReader ResolverContext m, MonadFail m, MonadError GQLError m, Monad MonadParam m) => MonadResolver (m :: Type -> Type) where {
    type family MonadOperation (m :: Type -> Type) :: OperationType;
    type family MonadEvent (m :: Type -> Type);
    type family MonadQuery (m :: Type -> Type) :: Type -> Type;
    type family MonadMutation (m :: Type -> Type) :: Type -> Type;
    type family MonadSubscription (m :: Type -> Type) :: Type -> Type;
    type family MonadParam (m :: Type -> Type) :: Type -> Type;
}
liftState :: MonadResolver m => ResolverState a -> m a
getArguments :: MonadResolver m => m (Arguments VALID)
subscribe :: (MonadResolver m, MonadOperation m ~ SUBSCRIPTION) => Channel (MonadEvent m) -> MonadQuery m (MonadEvent m -> m a) -> SubscriptionField (m a)
publish :: MonadResolver m => [MonadEvent m] -> m ()
runResolver :: MonadResolver m => Maybe (Selection VALID -> ResolverState (Channel (MonadEvent m))) -> m ValidValue -> ResolverContext -> ResponseStream (MonadEvent m) (MonadParam m) ValidValue
class (MonadResolver m, MonadIO m) => MonadIOResolver (m :: Type -> Type)
type family Flexible (m :: Type -> Type) (a :: k)
type family Composed (m :: Type -> Type) (f :: Type -> Type) (a :: k)