apollo-compiler/com.apollographql.apollo3.compiler

Package-level declarations

Types

AdapterInitializer

@Serializable

interface AdapterInitializer

Controls how scalar adapters are used in the generated code.

ApolloCompiler

object ApolloCompiler

ApolloCompilerPlugin

interface ApolloCompilerPlugin

Entry point for customizing the behaviour of the Apollo Compiler besides the already existing options

CodegenMetadata

@Serializable

class CodegenMetadata(val targetLanguage: TargetLanguage, val entries: List<ResolverEntry>)

CodegenMetadata contains information about what target classes were generated for each GraphQL types so that downstream modules can reuse them.

CodegenOptions

@Serializable

class CodegenOptions(val targetLanguage: TargetLanguage?, val packageName: String?, val rootPackageName: String?, val decapitalizeFields: Boolean?, val useSemanticNaming: Boolean?, val generateMethods: List<GeneratedMethod>?, val operationManifestFormat: String?, val generateSchema: Boolean?, val generatedSchemaName: String?, val sealedClassesForEnumsMatching: List<String>?, val generateAsInternal: Boolean?, val addUnknownForEnums: Boolean?, val addDefaultArgumentForInputObjects: Boolean?, val generateFilterNotNull: Boolean?, val generateInputBuilders: Boolean?, val addJvmOverloads: Boolean?, val requiresOptInAnnotation: String?, val jsExport: Boolean?, val generateModelBuilders: Boolean?, val classesForEnumsMatching: List<String>?, val generatePrimitiveTypes: Boolean?, val nullableFieldStyle: JavaNullable?, val generateFragmentImplementations: Boolean?, val generateQueryDocument: Boolean?) : SchemaCodegenOptions, OperationsCodegenOptions

CodegenSchema

@Serializable

class CodegenSchema(val schema: Schema, val normalizedPath: String, val scalarMapping: Map<String, ScalarInfo>, val generateDataBuilders: Boolean)

A Schema linked with other options that are bound to this schema and need to be the same in all modules using this schema

CodegenSchemaOptions

@Serializable

class CodegenSchemaOptions(val scalarMapping: Map<String, ScalarInfo>, val generateDataBuilders: Boolean?)

CommonCodegenOpt

interface CommonCodegenOpt

DocumentTransform

@ApolloExperimental

interface DocumentTransform

A DocumentTransform transforms operations and fragments at build time. DocumentTransform can add or remove fields automatically for an example.

ExpressionAdapterInitializer

@Serializable

@SerialName(value = "expression")

class ExpressionAdapterInitializer(val expression: String) : AdapterInitializer

The adapter expression will be used as-is (can be an object, a public val, a class instantiation).

GeneratedMethod

enum GeneratedMethod : Enum<GeneratedMethod>

InputFile

class InputFile(val file: File, val normalizedPath: String)

An input file together with its normalizedPath normalizedPath is used to compute the package name in some cases

IrOptions

@Serializable

class IrOptions(val fieldsOnDisjointTypesMustMerge: Boolean?, val decapitalizeFields: Boolean?, val flattenModels: Boolean?, val warnOnDeprecatedUsages: Boolean?, val failOnWarnings: Boolean?, val addTypename: String?, val generateOptionalOperationVariables: Boolean?, val alwaysGenerateTypesMatching: Set<String>?, val codegenModels: String?)

JavaCodegenOpt

interface JavaCodegenOpt

JavaNullable

enum JavaNullable : Enum<JavaNullable>

JavaOperationsCodegenOptions

interface JavaOperationsCodegenOptions : CommonCodegenOpt, OperationsCodegenOpt, JavaCodegenOpt

JavaSchemaCodegenOptions

interface JavaSchemaCodegenOptions : CommonCodegenOpt, SchemaCodegenOpt, JavaCodegenOpt

KotlinCodegenOpt

interface KotlinCodegenOpt

KotlinOperationsCodegenOptions

interface KotlinOperationsCodegenOptions : CommonCodegenOpt, OperationsCodegenOpt, KotlinCodegenOpt

KotlinSchemaCodegenOptions

interface KotlinSchemaCodegenOptions : CommonCodegenOpt, SchemaCodegenOpt, KotlinCodegenOpt

LayoutFactory

interface LayoutFactory

OperationIdGenerator

interface OperationIdGenerator

OperationOutputGenerator

@ApolloDeprecatedSince(version = ApolloDeprecatedSince.Version.v4_0_0)

interface ~~OperationOutputGenerator~~

A class that generates OperationOutput to compute the operationIds. OperationOutputGenerator works with a collection of OperationDescriptor for implementation that need to batch compute the operationIds. For an example to send all the operation at once to a backend for whitelisting.

OperationsCodegenOpt

interface OperationsCodegenOpt

OperationsCodegenOptions

interface OperationsCodegenOptions : JavaOperationsCodegenOptions, KotlinOperationsCodegenOptions

PackageNameGenerator

@ApolloDeprecatedSince(version = ApolloDeprecatedSince.Version.v4_0_0)

interface ~~PackageNameGenerator~~

A PackageNameGenerator computes the package name for a given file. Files can be either

Plugin

typealias ~~Plugin~~ = ApolloCompilerPlugin

RuntimeAdapterInitializer

@Serializable

@SerialName(value = "runtime")

object RuntimeAdapterInitializer : AdapterInitializer

The adapter instance will be looked up in the com.apollographql.apollo3.api.CustomScalarAdapters provided at runtime.

ScalarInfo

@Serializable

class ScalarInfo(val targetName: String, val adapterInitializer: AdapterInitializer = RuntimeAdapterInitializer, val userDefined: Boolean = true)

SchemaCodegenOpt

interface SchemaCodegenOpt

SchemaCodegenOptions

interface SchemaCodegenOptions : JavaSchemaCodegenOptions, KotlinSchemaCodegenOptions

TargetLanguage

enum TargetLanguage : Enum<TargetLanguage>

Transform

interface Transform<T>

Transforms a type

UsedCoordinates

@Serializable

class UsedCoordinates

Properties

ADD_TYPENAME_ALWAYS

const val ADD_TYPENAME_ALWAYS: String

ADD_TYPENAME_IF_ABSTRACT

const val ADD_TYPENAME_IF_ABSTRACT: String

ADD_TYPENAME_IF_FRAGMENTS

const val ADD_TYPENAME_IF_FRAGMENTS: String

ADD_TYPENAME_IF_POLYMORPHIC

const val ADD_TYPENAME_IF_POLYMORPHIC: String

APOLLO_VERSION

const val APOLLO_VERSION: String

MANIFEST_NONE

const val MANIFEST_NONE: String

MANIFEST_OPERATION_OUTPUT

const val MANIFEST_OPERATION_OUTPUT: String

MANIFEST_PERSISTED_QUERY

const val MANIFEST_PERSISTED_QUERY: String

MODELS_OPERATION_BASED

const val MODELS_OPERATION_BASED: String

MODELS_OPERATION_BASED_WITH_INTERFACES

const val MODELS_OPERATION_BASED_WITH_INTERFACES: String

MODELS_RESPONSE_BASED

const val MODELS_RESPONSE_BASED: String

Functions

buildCodegenOptions

fun buildCodegenOptions(targetLanguage: TargetLanguage? = null, decapitalizeFields: Boolean? = null, useSemanticNaming: Boolean? = null, generateMethods: List<GeneratedMethod>? = null, operationManifestFormat: String? = null, generateSchema: Boolean? = null, generatedSchemaName: String? = null, sealedClassesForEnumsMatching: List<String>? = null, generateAsInternal: Boolean? = null, addUnknownForEnums: Boolean? = null, addDefaultArgumentForInputObjects: Boolean? = null, generateFilterNotNull: Boolean? = null, generateInputBuilders: Boolean? = null, addJvmOverloads: Boolean? = null, requiresOptInAnnotation: String? = null, jsExport: Boolean? = null, generateModelBuilders: Boolean? = null, classesForEnumsMatching: List<String>? = null, generatePrimitiveTypes: Boolean? = null, nullableFieldStyle: JavaNullable? = null, generateFragmentImplementations: Boolean? = null, generateQueryDocument: Boolean? = null, packageName: String? = null, rootPackageName: String? = null): CodegenOptions

buildCodegenSchemaOptions

fun buildCodegenSchemaOptions(scalarMapping: Map<String, ScalarInfo> = emptyMap(), generateDataBuilders: Boolean? = null): CodegenSchemaOptions

buildIrOptions

fun buildIrOptions(fieldsOnDisjointTypesMustMerge: Boolean? = null, decapitalizeFields: Boolean? = null, flattenModels: Boolean? = null, warnOnDeprecatedUsages: Boolean? = null, failOnWarnings: Boolean? = null, addTypename: String? = null, generateOptionalOperationVariables: Boolean? = null, alwaysGenerateTypesMatching: Set<String>? = null, codegenModels: String? = null): IrOptions

capitalizeFirstLetter

fun String.capitalizeFirstLetter(): String

A variation of String.capitalize that:

decapitalizeFirstLetter

fun String.decapitalizeFirstLetter(): String

A variation of String.decapitalize that:

resolveSchemaType