Prospero.Parser

parseQuery :: String -> Either String (Array Selection)

Convenience wrapper: no variables, assumes query operation.

parseOperation :: String -> Map String InputValue -> Either String ParsedOperation

Parse a query with variable values, returning operation type and resolved selections.

parseOperationWithDefer :: String -> Map String InputValue -> Either String { deferred :: Array DeferredFragment, operationType :: OperationType, selections :: Array Selection }

Parse with @defer support, separating deferred fragments from immediate selections.

type ParsedOperation = { operationType :: OperationType, selections :: Array Selection }

type DeferredFragment = { label :: Maybe String, selections :: Array Selection }

type VariableDef = { colon :: SourceToken, defaultValue :: Maybe (SourceToken /\ Value), directives :: Array Directive, dollar :: SourceToken, name :: Name, type :: TypeRef }

data Value

Constructors

• ValueVariable SourceToken Name
• ValueInt SourceToken Int
• ValueFloat SourceToken Number
• ValueString SourceToken String
• ValueBlockString SourceToken String
• ValueBoolean SourceToken Boolean
• ValueNull SourceToken
• ValueEnum Name
• ValueList (Wrapped (Array Value))
• ValueObject (Wrapped (Array ObjectField))

data TypeRef

Constructors

• TypeNamed Name
• TypeList (Wrapped TypeRef)
• TypeNonNull TypeRef SourceToken

type TypeCondition = { name :: Name, on :: SourceToken }

type SelectionSet = Wrapped (Array Selection)

data Selection

Constructors

• SelectionField FieldNode
• SelectionFragmentSpread FragmentSpread
• SelectionInlineFragment InlineFragment

data OperationType

Constructors

• Query
• Mutation
• Subscription

Instances

• Eq OperationType
• Ord OperationType
• Show OperationType

type Operation = { directives :: Array Directive, name :: Maybe Name, operationType :: Maybe (SourceToken /\ OperationType), selectionSet :: SelectionSet, variableDefinitions :: Maybe (Wrapped (Array VariableDef)) }

type ObjectField = { colon :: SourceToken, name :: Name, value :: Value }

type InlineFragment = { directives :: Array Directive, selectionSet :: SelectionSet, spread :: SourceToken, typeCondition :: Maybe TypeCondition }

type FragmentSpread = { directives :: Array Directive, name :: Name, spread :: SourceToken }

type Fragment = { directives :: Array Directive, keyword :: SourceToken, name :: Name, selectionSet :: SelectionSet, typeCondition :: TypeCondition }

type FieldNode = { alias :: Maybe (Name /\ SourceToken), arguments :: Maybe (Wrapped (Array Argument)), directives :: Array Directive, name :: Name, selectionSet :: Maybe SelectionSet }

data Document

Constructors

• Document (Array Definition)

type Directive = { arguments :: Maybe (Wrapped (Array Argument)), at :: SourceToken, name :: Name }

data Definition

Constructors

• OperationDefinition Operation
• FragmentDefinition Fragment

type Argument = { colon :: SourceToken, name :: Name, value :: Value }

type ParseError = { message :: String, position :: SourcePos }

runParser :: forall a. Array SourceToken -> Parser a -> Either ParseError a

newtype Wrapped a

Constructors

• Wrapped { close :: SourceToken, open :: SourceToken, value :: a }

Instances

• Newtype (Wrapped a) _

data Trivia

Constructors

• WhitespaceTrivia String
• CommentTrivia String
• CommaTrivia

data Token

Constructors

• TokName String
• TokInt Int
• TokFloat Number
• TokString String
• TokBlockString String
• TokBang
• TokDollar
• TokAt
• TokColon
• TokEquals
• TokSpread
• TokLeftParen
• TokRightParen
• TokLeftBrace
• TokRightBrace
• TokLeftBracket
• TokRightBracket
• TokPipe
• TokEOF

Instances

• Eq Token

type SourceToken = { leadingTrivia :: Array Trivia, range :: SourceRange, value :: Token }

type SourceRange = { end :: SourcePos, start :: SourcePos }

type SourcePos = { column :: Int, line :: Int }

newtype Name

Constructors

• Name { name :: String, token :: SourceToken }

Instances

• Newtype Name _