apollo-ast/com.apollographql.apollo3.ast

Package com.apollographql.apollo3.ast

Types

class ConversionException(val error: String, val sourceLocation: SourceLocation = SourceLocation.UNKNOWN) : SourceAwareException

An exception while converting to/from introspection

GQLArgument

data class GQLArgument( val sourceLocation: SourceLocation = SourceLocation.UNKNOWN, val name: String, val value: GQLValue) : GQLNode

GQLArguments

data class GQLArguments(val arguments: List<GQLArgument>, val sourceLocation: SourceLocation = SourceLocation.UNKNOWN) : GQLNode

GQLBooleanValue

data class GQLBooleanValue(val sourceLocation: SourceLocation = SourceLocation.UNKNOWN, val value: Boolean) : GQLValue

GQLDefinition

interface GQLDefinition : GQLNode

GQLDescribed

interface GQLDescribed

A GQLNode that has a description

GQLDirective

data class GQLDirective( val sourceLocation: SourceLocation = SourceLocation.UNKNOWN, val name: String, val arguments: GQLArguments?) : GQLNode, GQLNamed

GQLDirectiveDefinition

data class GQLDirectiveDefinition( val sourceLocation: SourceLocation = SourceLocation.UNKNOWN, val description: String?, val name: String, val arguments: List<GQLInputValueDefinition>, val repeatable: Boolean, val locations: List<GQLDirectiveLocation>) : GQLDefinition, GQLNamed

GQLDirectiveLocation

enum GQLDirectiveLocation : Enum<GQLDirectiveLocation>

GQLDocument

data class GQLDocument(val definitions: List<GQLDefinition>, val filePath: String?) : GQLNode

The top level node in a GraphQL document. This can be a schema document or an executable document (or something else if need be)

GQLEnumTypeDefinition

data class GQLEnumTypeDefinition( val sourceLocation: SourceLocation = SourceLocation.UNKNOWN, val description: String?, val name: String, val directives: List<GQLDirective>, val enumValues: List<GQLEnumValueDefinition>) : GQLTypeDefinition

GQLEnumTypeExtension

data class GQLEnumTypeExtension( val sourceLocation: SourceLocation = SourceLocation.UNKNOWN, val name: String, val directives: List<GQLDirective>, val enumValues: List<GQLEnumValueDefinition>) : GQLDefinition, GQLTypeExtension

GQLEnumValue

data class GQLEnumValue(val sourceLocation: SourceLocation = SourceLocation.UNKNOWN, val value: String) : GQLValue

GQLEnumValueDefinition

data class GQLEnumValueDefinition( val sourceLocation: SourceLocation = SourceLocation.UNKNOWN, val description: String?, val name: String, val directives: List<GQLDirective>) : GQLNode, GQLNamed

GQLField

data class GQLField( val sourceLocation: SourceLocation = SourceLocation.UNKNOWN, val alias: String?, val name: String, val arguments: GQLArguments?, val directives: List<GQLDirective>, val selectionSet: GQLSelectionSet?) : GQLSelection

GQLFieldDefinition

data class GQLFieldDefinition( val sourceLocation: SourceLocation = SourceLocation.UNKNOWN, val description: String?, val name: String, val arguments: List<GQLInputValueDefinition>, val type: GQLType, val directives: List<GQLDirective>) : GQLNode, GQLNamed

GQLFloatValue

data class GQLFloatValue(val sourceLocation: SourceLocation = SourceLocation.UNKNOWN, val value: Double) : GQLValue

GQLFragmentDefinition

data class GQLFragmentDefinition( val sourceLocation: SourceLocation = SourceLocation.UNKNOWN, val name: String, val directives: List<GQLDirective>, val typeCondition: GQLNamedType, val selectionSet: GQLSelectionSet, val description: String?) : GQLDefinition, GQLNamed, GQLDescribed

GQLFragmentSpread

data class GQLFragmentSpread( val sourceLocation: SourceLocation = SourceLocation.UNKNOWN, val name: String, val directives: List<GQLDirective>) : GQLSelection

GQLInlineFragment

data class GQLInlineFragment( val sourceLocation: SourceLocation = SourceLocation.UNKNOWN, val typeCondition: GQLNamedType, val directives: List<GQLDirective>, val selectionSet: GQLSelectionSet) : GQLSelection

GQLInputObjectTypeDefinition

data class GQLInputObjectTypeDefinition( val sourceLocation: SourceLocation = SourceLocation.UNKNOWN, val description: String?, val name: String, val directives: List<GQLDirective>, val inputFields: List<GQLInputValueDefinition>) : GQLTypeDefinition

GQLInputObjectTypeExtension

data class GQLInputObjectTypeExtension( val sourceLocation: SourceLocation = SourceLocation.UNKNOWN, val name: String, val directives: List<GQLDirective>, val inputFields: List<GQLInputValueDefinition>) : GQLDefinition, GQLTypeExtension

GQLInputValueDefinition

data class GQLInputValueDefinition( val sourceLocation: SourceLocation = SourceLocation.UNKNOWN, val description: String?, val name: String, val directives: List<GQLDirective>, val type: GQLType, val defaultValue: GQLValue?) : GQLNode, GQLNamed

GQLInterfaceTypeDefinition

data class GQLInterfaceTypeDefinition( val sourceLocation: SourceLocation = SourceLocation.UNKNOWN, val description: String?, val name: String, val implementsInterfaces: List<String>, val directives: List<GQLDirective>, val fields: List<GQLFieldDefinition>) : GQLTypeDefinition

GQLInterfaceTypeExtension

data class GQLInterfaceTypeExtension( val sourceLocation: SourceLocation = SourceLocation.UNKNOWN, val name: String, val implementsInterfaces: List<String>, val directives: List<GQLDirective>, val fields: List<GQLFieldDefinition>) : GQLDefinition, GQLTypeExtension, GQLNamed

GQLIntValue

data class GQLIntValue(val sourceLocation: SourceLocation = SourceLocation.UNKNOWN, val value: Int) : GQLValue

GQLListType

data class GQLListType(val sourceLocation: SourceLocation = SourceLocation.UNKNOWN, val type: GQLType) : GQLType

GQLListValue

data class GQLListValue(val sourceLocation: SourceLocation = SourceLocation.UNKNOWN, val values: List<GQLValue>) : GQLValue

GQLNamed

interface GQLNamed

A GQLNode that has a name

GQLNamedType

data class GQLNamedType(val sourceLocation: SourceLocation = SourceLocation.UNKNOWN, val name: String) : GQLType, GQLNamed

GQLNode

interface GQLNode

A node in the GraphQL AST.

GQLNonNullType

data class GQLNonNullType(val sourceLocation: SourceLocation = SourceLocation.UNKNOWN, val type: GQLType) : GQLType

GQLNullValue

data class GQLNullValue(val sourceLocation: SourceLocation = SourceLocation.UNKNOWN) : GQLValue

GQLObjectField

data class GQLObjectField( val sourceLocation: SourceLocation = SourceLocation.UNKNOWN, val name: String, val value: GQLValue) : GQLNode

GQLObjectTypeDefinition

data class GQLObjectTypeDefinition( val sourceLocation: SourceLocation = SourceLocation.UNKNOWN, val description: String?, val name: String, val implementsInterfaces: List<String>, val directives: List<GQLDirective>, val fields: List<GQLFieldDefinition>) : GQLTypeDefinition

GQLObjectTypeExtension

data class GQLObjectTypeExtension( val sourceLocation: SourceLocation = SourceLocation.UNKNOWN, val name: String, val implementsInterfaces: List<String>, val directives: List<GQLDirective>, val fields: List<GQLFieldDefinition>) : GQLDefinition, GQLTypeExtension

GQLObjectValue

data class GQLObjectValue(val sourceLocation: SourceLocation = SourceLocation.UNKNOWN, val fields: List<GQLObjectField>) : GQLValue

GQLOperationDefinition

data class GQLOperationDefinition( val sourceLocation: SourceLocation = SourceLocation.UNKNOWN, val operationType: String, val name: String?, val variableDefinitions: List<GQLVariableDefinition>, val directives: List<GQLDirective>, val selectionSet: GQLSelectionSet, val description: String?) : GQLDefinition, GQLDescribed

GQLOperationTypeDefinition

data class GQLOperationTypeDefinition( val sourceLocation: SourceLocation = SourceLocation.UNKNOWN, val operationType: String, val namedType: String) : GQLNode

GQLResult

class GQLResult<out V : Any>(val value: V?, val issues: List<Issue>)

The result of a parsing or validation operation. It's tri-state:

GQLScalarTypeDefinition

data class GQLScalarTypeDefinition( val sourceLocation: SourceLocation = SourceLocation.UNKNOWN, val description: String?, val name: String, val directives: List<GQLDirective>) : GQLTypeDefinition

GQLScalarTypeExtension

data class GQLScalarTypeExtension( val sourceLocation: SourceLocation = SourceLocation.UNKNOWN, val name: String, val directives: List<GQLDirective>) : GQLDefinition, GQLTypeExtension

GQLSchemaDefinition

data class GQLSchemaDefinition( val sourceLocation: SourceLocation = SourceLocation.UNKNOWN, val description: String?, val directives: List<GQLDirective>, val rootOperationTypeDefinitions: List<GQLOperationTypeDefinition>) : GQLDefinition

GQLSchemaExtension

data class GQLSchemaExtension( val sourceLocation: SourceLocation = SourceLocation.UNKNOWN, val directives: List<GQLDirective>, val operationTypesDefinition: List<GQLOperationTypeDefinition>) : GQLDefinition, GQLTypeSystemExtension

GQLSelection

sealed class GQLSelection : GQLNode

GQLSelectionSet

data class GQLSelectionSet(val selections: List<GQLSelection>, val sourceLocation: SourceLocation = SourceLocation.UNKNOWN) : GQLNode

GQLStringValue

data class GQLStringValue(val sourceLocation: SourceLocation = SourceLocation.UNKNOWN, val value: String) : GQLValue

GQLType

sealed class GQLType : GQLNode

GQLTypeDefinition

sealed class GQLTypeDefinition : GQLDefinition, GQLNamed, GQLDescribed

GQLTypeExtension

interface GQLTypeExtension : GQLTypeSystemExtension, GQLNamed

GQLTypeSystemExtension

interface GQLTypeSystemExtension : GQLNode

GQLUnionTypeDefinition

data class GQLUnionTypeDefinition( val sourceLocation: SourceLocation = SourceLocation.UNKNOWN, val description: String?, val name: String, val directives: List<GQLDirective>, val memberTypes: List<GQLNamedType>) : GQLTypeDefinition

GQLUnionTypeExtension

data class GQLUnionTypeExtension( val sourceLocation: SourceLocation = SourceLocation.UNKNOWN, val name: String, val directives: List<GQLDirective>, val memberTypes: List<GQLNamedType>) : GQLDefinition, GQLTypeExtension

GQLValue

sealed class GQLValue : GQLNode

GQLVariableDefinition

data class GQLVariableDefinition( val sourceLocation: SourceLocation = SourceLocation.UNKNOWN, val name: String, val type: GQLType, val defaultValue: GQLValue?, val directives: List<GQLDirective>) : GQLNode

A variable definition is very similar to an InputValue definition except it doesn't have a description

GQLVariableValue

data class GQLVariableValue(val sourceLocation: SourceLocation = SourceLocation.UNKNOWN, val name: String) : GQLValue

InferredVariable

class InferredVariable(val name: String, val type: GQLType)

A variable that is inferred from its usages in fragments This is used to create executable fragments

Issue

sealed class Issue

All the issues that can be collected while analyzing a graphql document

NodeContainer

class NodeContainer(nodes: List<GQLNode>)

NodeTransformer

fun interface NodeTransformer

QueryDocumentMinifier

object QueryDocumentMinifier

Schema

class Schema

A wrapper around a schema GQLDocument that ensures the GQLDocument is valid and caches some extra information. In particular, Schema:

SchemaValidationException

class SchemaValidationException(val error: String, val sourceLocation: SourceLocation = SourceLocation.UNKNOWN) : SourceAwareException

The schema is invalid

SDLWriter

open class SDLWriter(sink: BufferedSink, indent: String) : Closeable

A SDLWriter writes utf8 text to the given sink and supports indent/unindent

SourceAwareException

open class SourceAwareException(val error: String, val sourceLocation: SourceLocation) : RuntimeException

SourceLocation

class SourceLocation( val line: Int, val position: Int, val filePath: String?)

TransformResult

interface TransformResult

UnrecognizedAntlrRule

class UnrecognizedAntlrRule(val error: String, val sourceLocation: SourceLocation) : SourceAwareException

Something went wrong while building the GraphQL AST, analyzing the schema, ...

ValidationDetails

enum ValidationDetails : Enum<ValidationDetails>

VariableUsage

class VariableUsage( val variable: GQLVariableValue, val locationType: GQLType, val hasLocationDefaultValue: Boolean)

A variable used in a GQLValue

Functions

apolloDefinitions

~~fun~~ ~~apolloDefinitions~~(): List<GQLDefinition>

fun apolloDefinitions(version: String): List<GQLDefinition>

Extra apollo specific definitions from https://specs.apollo.dev/kotlin_labs/<[version]>

builtinDefinitions

fun builtinDefinitions(): List<GQLDefinition>

Definitions from the spec

canHaveKeyFields

fun GQLTypeDefinition.canHaveKeyFields(): Boolean

checkKeyFields

fun checkKeyFields( fragmentDefinition: GQLFragmentDefinition, schema: Schema, allFragmentDefinitions: Map<String, GQLFragmentDefinition>)

fun checkKeyFields( operation: GQLOperationDefinition, schema: Schema, allFragmentDefinitions: Map<String, GQLFragmentDefinition>)

checkNoErrors

fun List<Issue>.checkNoErrors()

coerceInExecutableContextOrThrow

fun GQLValue.coerceInExecutableContextOrThrow(expectedType: GQLType, schema: Schema): GQLValue

For a GQLValue used in input position, validate that it can be coerced to expectedType and coerce it at the same time.

coerceInSchemaContextOrThrow

fun GQLValue.coerceInSchemaContextOrThrow(expectedType: GQLType, schema: Schema): GQLValue

For a GQLValue used in input position, validate that it can be coerced to expectedType and coerce it at the same time.

containsError

fun List<Issue>.containsError(): Boolean

decodeAsGraphQLSingleQuoted

fun String.decodeAsGraphQLSingleQuoted(): String

decodeAsGraphQLTripleQuoted

fun String.decodeAsGraphQLTripleQuoted(): String

definitionFromScope

fun GQLField.definitionFromScope(schema: Schema, parentTypeDefinition: GQLTypeDefinition): GQLFieldDefinition?

fun GQLField.definitionFromScope(schema: Schema, rawTypename: String): GQLFieldDefinition?

encodeToGraphQLSingleQuoted

fun String.encodeToGraphQLSingleQuoted(): String

https://spec.graphql.org/draft/#EscapedCharacter

encodeToGraphQLTripleQuoted

fun String.encodeToGraphQLTripleQuoted(): String

findDeprecationReason

fun List<GQLDirective>.findDeprecationReason(): String?

findNonnull

@ApolloDeprecatedSince(version = ApolloDeprecatedSince.Version.v3_3_1)

~~fun~~ List<GQLDirective>.~~findNonnull~~(): Boolean

fun List<GQLDirective>.findNonnull(schema: Schema): Boolean

findOptInFeature

fun List<GQLDirective>.findOptInFeature(schema: Schema): String?

findTargetName

fun List<GQLDirective>.findTargetName(schema: Schema): String?

implementsAbstractType

fun GQLTypeDefinition.implementsAbstractType(schema: Schema): Boolean

inferVariables

@ApolloExperimental

fun GQLFragmentDefinition.inferVariables( schema: Schema, fragments: Map<String, GQLFragmentDefinition>, fieldsOnDisjointTypesMustMerge: Boolean): List<InferredVariable>

Infers the variables from a given fragment

isAbstract

fun GQLTypeDefinition.isAbstract(): Boolean

isApollo

@ApolloDeprecatedSince(version = ApolloDeprecatedSince.Version.v3_3_1)

~~fun~~ GQLDirective.~~isApollo~~(): Boolean

isFieldNonNull

@ApolloDeprecatedSince(version = ApolloDeprecatedSince.Version.v3_3_1)

~~fun~~ GQLTypeDefinition.~~isFieldNonNull~~(fieldName: String): Boolean

fun GQLTypeDefinition.isFieldNonNull(fieldName: String, schema: Schema? = null): Boolean

leafType

~~fun~~ GQLType.~~leafType~~(): GQLNamedType

linkDefinitions

fun linkDefinitions(): List<GQLDefinition>

The @link definition for bootstrapping

optionalValue

@ApolloDeprecatedSince(version = ApolloDeprecatedSince.Version.v3_3_1)

~~fun~~ List<GQLDirective>.~~optionalValue~~(): Boolean?

fun List<GQLDirective>.optionalValue(schema: Schema?): Boolean?

parseAsGQLDocument

@ApolloExperimental

fun BufferedSource.parseAsGQLDocument(filePath: String? = null): GQLResult<GQLDocument>

Parses the source to a GQLDocument, validating the syntax but not the contents of the document.

parseAsGQLSelections

@ApolloExperimental

fun BufferedSource.parseAsGQLSelections(filePath: String? = null): GQLResult<List<GQLSelection>>

Parses the source to a List<GQLSelection>, validating the syntax but not the contents of the selections.

parseAsGQLValue

@ApolloExperimental

fun BufferedSource.parseAsGQLValue(filePath: String? = null): GQLResult<GQLValue>

Parses the source to a GQLValue, validating the syntax but not the contents of the value.

possibleTypes

fun GQLTypeDefinition.possibleTypes(schema: Schema): Set<String>

pretty

fun GQLType.pretty(): String

rawType

fun GQLType.rawType(): GQLNamedType

Returns the raw type. The raw type is the GQLNamedType without any list/nonnull wrapper types

responseName

fun GQLField.responseName(): String

rootTypeDefinition

fun GQLOperationDefinition.rootTypeDefinition(schema: Schema): GQLTypeDefinition?

toExecutableDefinitions

@ApolloExperimental

fun BufferedSource.toExecutableDefinitions( schema: Schema, filePath: String? = null, fieldsOnDisjointTypesMustMerge: Boolean = true): List<GQLDefinition>

Parses the source to a List<GQLDefinition>, throwing on parsing or validation errors.

toSchema

@ApolloExperimental

fun BufferedSource.toSchema(filePath: String? = null): Schema

Parses the source to a Schema, throwing on parsing or validation errors.

toUtf8