apollo-ast/com.apollographql.apollo.ast

Package-level declarations

Types

AnonymousOperation

class AnonymousOperation(val message: String, val sourceLocation: SourceLocation?) : ApolloIssue

ApolloIssue

sealed interface ApolloIssue : Issue

A custom issue specific to the Apollo compiler

Catch

data class Catch(val to: CatchTo, val levels: List<Int>?)

CatchTo

enum CatchTo : Enum<CatchTo>

ConditionalFragment

class ConditionalFragment(val message: String, val sourceLocation: SourceLocation?) : ApolloIssue

A fragment has an @include or @skip directive. While this is valid GraphQL, the responseBased codegen does not support that

ConversionException

class ConversionException(val error: String, val sourceLocation: SourceLocation? = null) : SourceAwareException

An exception while converting to/from introspection

DeprecatedUsage

class DeprecatedUsage(val message: String, val sourceLocation: SourceLocation?) : ApolloIssue

A deprecated field/inputField/enumValue/directive is used

DifferentShape

class DifferentShape(val message: String, val sourceLocation: SourceLocation?) : GraphQLValidationIssue

Fields have different shapes and cannot be merged

DirectiveRedefinition

class DirectiveRedefinition(val name: String, existingSourceLocation: SourceLocation?, val sourceLocation: SourceLocation?) : GraphQLValidationIssue

DuplicateDeferLabel

class DuplicateDeferLabel(val message: String, val sourceLocation: SourceLocation?) : ApolloIssue

DuplicateTypeName

class DuplicateTypeName(val message: String, val sourceLocation: SourceLocation?) : GraphQLValidationIssue

Two type definitions have the same name

ExecutableValidationResult

@ApolloExperimental

class ExecutableValidationResult(val fragmentVariableUsages: Map<String, List<VariableUsage>>, val issues: List<Issue>)

ForeignSchema

@ApolloExperimental

class ForeignSchema(val name: String, val version: String, val definitions: List<GQLDefinition>, val directivesToStrip: List<String> = definitions.filterIsInstance<GQLDirective>().map { it.name })

A known foreign schema

GQLArgument

class GQLArgument(val sourceLocation: SourceLocation? = null, val name: String, val value: GQLValue) : GQLNode, GQLNamed

GQLArguments

@ApolloDeprecatedSince(version = ApolloDeprecatedSince.Version.v4_0_0)

class ~~GQLArguments~~(val arguments: List<GQLArgument>, val sourceLocation: SourceLocation? = null) : GQLNode

GQLBooleanValue

class GQLBooleanValue(val sourceLocation: SourceLocation? = null, val value: Boolean) : GQLValue

GQLDefinition

sealed interface GQLDefinition : GQLNode

GQLDescribed

interface GQLDescribed

A GQLNode that has a description

GQLDirective

class GQLDirective(val sourceLocation: SourceLocation? = null, val name: String, val arguments: List<GQLArgument>) : GQLNode, GQLNamed

GQLDirectiveDefinition

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

GQLDirectiveLocation

enum GQLDirectiveLocation : Enum<GQLDirectiveLocation>

GQLDocument

class GQLDocument(val definitions: List<GQLDefinition>, val sourceLocation: SourceLocation?) : 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

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

GQLEnumTypeExtension

class GQLEnumTypeExtension(val sourceLocation: SourceLocation? = null, val name: String, val directives: List<GQLDirective>, val enumValues: List<GQLEnumValueDefinition>) : GQLDefinition, GQLTypeExtension, GQLHasDirectives

GQLEnumValue

class GQLEnumValue(val sourceLocation: SourceLocation? = null, val value: String) : GQLValue

GQLEnumValueDefinition

class GQLEnumValueDefinition(val sourceLocation: SourceLocation? = null, val description: String?, val name: String, val directives: List<GQLDirective>) : GQLNode, GQLDescribed, GQLNamed, GQLHasDirectives

GQLExecutableDefinition

sealed interface GQLExecutableDefinition : GQLDefinition

GQLField

class GQLField @ApolloExperimental constructor(val sourceLocation: SourceLocation? = null, val alias: String?, val name: String, val arguments: List<GQLArgument>, val directives: List<GQLDirective>, val selections: List<GQLSelection>) : GQLSelection, GQLNamed, GQLHasDirectives

GQLFieldDefinition

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

GQLFloatValue

class GQLFloatValue(val sourceLocation: SourceLocation? = null, val value: String) : GQLValue

GQLFragmentDefinition

class GQLFragmentDefinition(val sourceLocation: SourceLocation? = null, val name: String, val directives: List<GQLDirective>, val typeCondition: GQLNamedType, val selections: List<GQLSelection>, val description: String?) : GQLExecutableDefinition, GQLNamed, GQLDescribed, GQLHasDirectives

GQLFragmentSpread

class GQLFragmentSpread(val sourceLocation: SourceLocation? = null, val name: String, val directives: List<GQLDirective>) : GQLSelection, GQLNamed, GQLHasDirectives

GQLHasDirectives

interface GQLHasDirectives

GQLInlineFragment

class GQLInlineFragment(val sourceLocation: SourceLocation? = null, val typeCondition: GQLNamedType?, val directives: List<GQLDirective>, val selections: List<GQLSelection>) : GQLSelection, GQLHasDirectives

GQLInputObjectTypeDefinition

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

GQLInputObjectTypeExtension

class GQLInputObjectTypeExtension(val sourceLocation: SourceLocation? = null, val name: String, val directives: List<GQLDirective>, val inputFields: List<GQLInputValueDefinition>) : GQLDefinition, GQLTypeExtension, GQLHasDirectives

GQLInputValueDefinition

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

GQLInterfaceTypeDefinition

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

GQLInterfaceTypeExtension

class GQLInterfaceTypeExtension(val sourceLocation: SourceLocation? = null, val name: String, val implementsInterfaces: List<String>, val directives: List<GQLDirective>, val fields: List<GQLFieldDefinition>) : GQLDefinition, GQLTypeExtension, GQLNamed, GQLHasDirectives

GQLIntValue

class GQLIntValue(val sourceLocation: SourceLocation? = null, val value: String) : GQLValue

GQLListType

class GQLListType(val sourceLocation: SourceLocation? = null, val type: GQLType) : GQLType

GQLListValue

class GQLListValue(val sourceLocation: SourceLocation? = null, val values: List<GQLValue>) : GQLValue

GQLNamed

interface GQLNamed

A GQLNode that has a name

GQLNamedType

class GQLNamedType(val sourceLocation: SourceLocation? = null, val name: String) : GQLType, GQLNamed

GQLNode

sealed interface GQLNode

A node in the GraphQL AST.

GQLNonNullType

class GQLNonNullType(val sourceLocation: SourceLocation? = null, val type: GQLType) : GQLType

GQLNullValue

class GQLNullValue(val sourceLocation: SourceLocation? = null) : GQLValue

GQLObjectField

class GQLObjectField(val sourceLocation: SourceLocation? = null, val name: String, val value: GQLValue) : GQLNode, GQLNamed

GQLObjectTypeDefinition

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

GQLObjectTypeExtension

class GQLObjectTypeExtension(val sourceLocation: SourceLocation? = null, val name: String, val implementsInterfaces: List<String>, val directives: List<GQLDirective>, val fields: List<GQLFieldDefinition>) : GQLDefinition, GQLTypeExtension, GQLHasDirectives

GQLObjectValue

class GQLObjectValue(val sourceLocation: SourceLocation? = null, val fields: List<GQLObjectField>) : GQLValue

GQLOperationDefinition

class GQLOperationDefinition(val sourceLocation: SourceLocation? = null, val operationType: String, val name: String?, val variableDefinitions: List<GQLVariableDefinition>, val directives: List<GQLDirective>, val selections: List<GQLSelection>, val description: String?) : GQLExecutableDefinition, GQLDescribed, GQLHasDirectives

GQLOperationTypeDefinition

class GQLOperationTypeDefinition(val sourceLocation: SourceLocation? = null, 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

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

GQLScalarTypeExtension

class GQLScalarTypeExtension(val sourceLocation: SourceLocation? = null, val name: String, val directives: List<GQLDirective>) : GQLDefinition, GQLTypeExtension, GQLHasDirectives

GQLSchemaDefinition

class GQLSchemaDefinition(val sourceLocation: SourceLocation? = null, val description: String?, val directives: List<GQLDirective>, val rootOperationTypeDefinitions: List<GQLOperationTypeDefinition>) : GQLDefinition, GQLDescribed, GQLHasDirectives

GQLSchemaExtension

class GQLSchemaExtension(val sourceLocation: SourceLocation? = null, val directives: List<GQLDirective>, val operationTypeDefinitions: List<GQLOperationTypeDefinition>) : GQLDefinition, GQLTypeSystemExtension, GQLHasDirectives

GQLSelection

sealed class GQLSelection : GQLNode

GQLSelectionSet

@ApolloDeprecatedSince(version = ApolloDeprecatedSince.Version.v4_0_0)

class ~~GQLSelectionSet~~(val selections: List<GQLSelection>, val sourceLocation: SourceLocation? = null) : GQLNode

GQLStringValue

class GQLStringValue(val sourceLocation: SourceLocation? = null, val value: String) : GQLValue

GQLType

sealed class GQLType : GQLNode

GQLTypeDefinition

sealed class GQLTypeDefinition : GQLDefinition, GQLNamed, GQLDescribed, GQLHasDirectives

GQLTypeExtension

sealed interface GQLTypeExtension : GQLTypeSystemExtension, GQLNamed

GQLTypeSystemExtension

sealed interface GQLTypeSystemExtension : GQLDefinition

GQLUnionTypeDefinition

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

GQLUnionTypeExtension

class GQLUnionTypeExtension(val sourceLocation: SourceLocation? = null, val name: String, val directives: List<GQLDirective>, val memberTypes: List<GQLNamedType>) : GQLDefinition, GQLTypeExtension, GQLHasDirectives

GQLValue

sealed class GQLValue : GQLNode

GQLVariableDefinition

class GQLVariableDefinition(val sourceLocation: SourceLocation? = null, val name: String, val type: GQLType, val defaultValue: GQLValue?, val directives: List<GQLDirective>) : GQLNode, GQLNamed, GQLHasDirectives

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

GQLVariableValue

class GQLVariableValue(val sourceLocation: SourceLocation? = null, val name: String) : GQLValue, GQLNamed

GraphQLIssue

sealed interface GraphQLIssue : Issue

An issue from the GraphQL spec

GraphQLValidationIssue

sealed interface GraphQLValidationIssue : GraphQLIssue

A validation issue from the GraphQL spec

IncompatibleDefinition

class IncompatibleDefinition(name: String, expectedDefinition: String, val sourceLocation: SourceLocation?) : GraphQLValidationIssue

The definition is inconsistent with the expected one.

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

InlineFragmentWithoutTypeCondition

class InlineFragmentWithoutTypeCondition(val message: String, val sourceLocation: SourceLocation?) : ApolloIssue

The GraphQL spec allows inline fragments without a type condition, but we currently forbid this because we need the type condition to name the models in operation based codegen.

InvalidDeferDirective

class InvalidDeferDirective(val message: String, val sourceLocation: SourceLocation?) : ApolloIssue

InvalidDeferLabel

class InvalidDeferLabel(val message: String, val sourceLocation: SourceLocation?) : ApolloIssue

Issue

sealed interface Issue

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

MergeOptions

@ApolloExperimental

class MergeOptions(val allowFieldNullabilityModification: Boolean)

NodeContainer

class NodeContainer(nodes: List<GQLNode>)

NodeTransformer

@ApolloExperimental

fun interface NodeTransformer

NoQueryType

class NoQueryType(val message: String, val sourceLocation: SourceLocation?) : GraphQLValidationIssue

OtherValidationIssue

class OtherValidationIssue(val message: String, val sourceLocation: SourceLocation?) : GraphQLValidationIssue

Another GraphQL validation error as per the spec

ParserOptions

class ParserOptions

ParsingError

class ParsingError(val message: String, val sourceLocation: SourceLocation?) : GraphQLIssue

A grammar error

QueryDocumentMinifier

object QueryDocumentMinifier

ReservedEnumValueName

class ReservedEnumValueName(val message: String, val sourceLocation: SourceLocation?) : ApolloIssue

Certain enum value names such as type are reserved for Apollo.

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? = null) : 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 start: Int, val end: Int, val line: Int, val column: Int, val filePath: String?)

TransformResult

@ApolloExperimental

sealed interface TransformResult

UnknownDirective

class UnknownDirective constructor(val message: String, val sourceLocation: SourceLocation?, val requireDefinition: Boolean) : GraphQLValidationIssue

An unknown directive was found.

UnusedFragment

class UnusedFragment(val message: String, val sourceLocation: SourceLocation?) : GraphQLValidationIssue

UnusedVariable

class UnusedVariable(val message: String, val sourceLocation: SourceLocation?) : ApolloIssue

A variable is unused

UpperCaseField

class UpperCaseField(val message: String, val sourceLocation: SourceLocation?) : ApolloIssue

When models are nested, upper case fields are not supported as Kotlin doesn't allow a property name with the same name as a nested class. If this happens, the easiest solution is to add an alias with a lower case first letter. If there are a lot of such fields, the Apollo compiler option flattenModels can also be used to circumvent this error at the price of possible suffixes in model names.

VariableDeferLabel

class VariableDeferLabel(val message: String, val sourceLocation: SourceLocation?) : ApolloIssue

VariableUsage

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

A variable used in a GQLValue

Properties

KOTLIN_LABS_VERSION

const val KOTLIN_LABS_VERSION: String

NULLABILITY_VERSION

const val NULLABILITY_VERSION: String

Functions

builtinDefinitions

fun builtinDefinitions(): List<GQLDefinition>

Definitions from the spec

builtinForeignSchemas

@ApolloExperimental

fun builtinForeignSchemas(): List<ForeignSchema>

The foreign schemas supported by Apollo Kotlin. This is exported in case users want to validate documents meant for Apollo Kotlin.

canHaveKeyFields

fun GQLTypeDefinition.canHaveKeyFields(): Boolean

checkEmpty

fun List<Issue>.checkEmpty()

Checks that a list of issue is empty, regardless of the issues. This may throw on Apollo specific issues.

checkValidGraphQL

fun List<Issue>.checkValidGraphQL()

Checks that a list of issues is valid GraphQL per the spec. This ignores any ApolloIssue

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.

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

Escapes a single quoted string. The 2 mandatory characters to be escaped are " and \. For better readability, control codes are also escaped. Although / may be escaped, we leave it as is for better readability.

encodeToGraphQLTripleQuoted

fun String.encodeToGraphQLTripleQuoted(): String

fieldDefinitions

fun GQLTypeDefinition.fieldDefinitions(schema: Schema): List<GQLFieldDefinition>

findCatch

fun GQLField.findCatch(schema: Schema): Catch?

fun List<GQLDirective>.findCatch(schema: Schema): Catch?

findCatchByDefault

fun GQLFragmentDefinition.findCatchByDefault(schema: Schema): CatchTo?

fun GQLOperationDefinition.findCatchByDefault(schema: Schema): CatchTo?

findDeprecationReason

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

findNonnull

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

findOneOf

fun List<GQLDirective>.findOneOf(): Boolean

findOptInFeature

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

findSemanticNonNulls

fun GQLFieldDefinition.findSemanticNonNulls(schema: Schema): List<Int>

findSpecifiedBy

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

findTargetName

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

getArgumentValueOrDefault

fun GQLDirective.getArgumentValueOrDefault(argName: String, schema: Schema): GQLValue?

implementsAbstractType

fun GQLTypeDefinition.implementsAbstractType(schema: Schema): Boolean

isAbstract

fun GQLTypeDefinition.isAbstract(): Boolean

isFieldNonNull

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

kotlinLabsDefinitions

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

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

leafType

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

linkDefinitions

fun linkDefinitions(): List<GQLDefinition>

The @link definition for bootstrapping

mergeExtensions

@ApolloExperimental

fun GQLDocument.mergeExtensions(mergeOptions: MergeOptions = MergeOptions.Default): GQLResult<GQLDocument>

nullabilityDefinitions

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

Extra nullability definitions from https://specs.apollo.dev/nullability/<version>

optionalValue

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

parseAsGQLDocument

fun String.parseAsGQLDocument(options: ParserOptions = ParserOptions.Default): GQLResult<GQLDocument>

@ApolloExperimental

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

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

fun Path.parseAsGQLDocument(options: ParserOptions = ParserOptions.Default): GQLResult<GQLDocument>

fun File.parseAsGQLDocument(options: <Error class: unknown class> = ParserOptions.Default): <Error class: unknown class><<Error class: unknown class>>

parseAsGQLSelections

fun String.parseAsGQLSelections(options: ParserOptions = ParserOptions.Default): GQLResult<List<GQLSelection>>

@ApolloExperimental

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

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

parseAsGQLType

fun String.parseAsGQLType(options: ParserOptions = ParserOptions.Default): GQLResult<GQLType>

@ApolloExperimental

fun BufferedSource.parseAsGQLType(filePath: String? = null, options: ParserOptions = ParserOptions.Default): GQLResult<GQLType>

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

parseAsGQLValue

fun String.parseAsGQLValue(options: ParserOptions = ParserOptions.Default): GQLResult<GQLValue>

@ApolloExperimental

fun BufferedSource.parseAsGQLValue(filePath: String? = null, options: ParserOptions = ParserOptions.Default): 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

fun SourceLocation?.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?

toExecutableDocument

@ApolloExperimental

fun BufferedSource.toExecutableDocument(schema: Schema, filePath: String? = null): GQLDocument

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

toFullSchemaGQLDocument

@ApolloExperimental

fun GQLDocument.toFullSchemaGQLDocument(): GQLDocument

Returns a "full schema" document. Full schema documents are for use by clients and other tools that need to know what features are supported by a given server. They include builtin directives and merge all type extensions

toGQLDocument