com.expediagroup.graphql.plugin.gradle.GraphQLPluginExtension.kt Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of graphql-kotlin-gradle-plugin Show documentation
Gradle Kotlin Gradle Plugin that can generate type-safe GraphQL Kotlin client and GraphQL schema in SDL format using reflections
There is a newer version: 8.2.1
Show newest version
/*
 * Copyright 2021 Expedia, Inc
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     https://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package com.expediagroup.graphql.plugin.gradle

import com.expediagroup.graphql.plugin.gradle.config.GraphQLParserOptions
import com.expediagroup.graphql.plugin.gradle.config.GraphQLScalar
import com.expediagroup.graphql.plugin.gradle.config.GraphQLSerializer
import com.expediagroup.graphql.plugin.gradle.config.TimeoutConfiguration
import org.gradle.api.Action
import java.io.File

/**
 * GraphQL Kotlin Gradle Plugin extension.
 */
@Suppress("UnstableApiUsage")
open class GraphQLPluginExtension {

    private var clientExtensionConfigured: Boolean = false
    internal val clientExtension: GraphQLPluginClientExtension by lazy {
        clientExtensionConfigured = true
        GraphQLPluginClientExtension()
    }
    private var schemaExtensionConfigured: Boolean = false
    internal val schemaExtension: GraphQLPluginSchemaExtension by lazy {
        schemaExtensionConfigured = true
        GraphQLPluginSchemaExtension()
    }

    private var graalVmExtensionConfigured: Boolean = false
    internal val graalVmExtension: GraphQLPluginGraalVmExtension by lazy {
        graalVmExtensionConfigured = true
        GraphQLPluginGraalVmExtension()
    }

    /** Plugin configuration for generating GraphQL client. */
    fun client(action: Action) {
        action.execute(clientExtension)
    }

    internal fun isClientConfigurationAvailable(): Boolean = clientExtensionConfigured

    internal fun isSchemaConfigurationAvailable(): Boolean = schemaExtensionConfigured

    internal fun isGraalVmConfigurationAvailable(): Boolean = graalVmExtensionConfigured

    /** Plugin configuration for generating GraphQL schema artifact. */
    fun schema(action: Action) {
        action.execute(schemaExtension)
    }

    fun graalVm(action: Action) {
        action.execute(graalVmExtension)
    }
}

open class GraphQLPluginClientExtension {
    /** GraphQL server endpoint that will be used to for running introspection queries. Alternatively you can download schema directly from [sdlEndpoint] or specify local [schemaFile]. */
    var endpoint: String? = null
    /** GraphQL server SDL endpoint that will be used to download schema. Alternatively you can run introspection query against [endpoint] or specify local [schemaFile]. */
    var sdlEndpoint: String? = null
    /** GraphQL schema file. Can be used instead of [endpoint] or [sdlEndpoint]. */
    var schemaFile: File? = null
    /** Target package name to be used for generated classes. */
    var packageName: String? = null
    /** Optional HTTP headers to be specified on an introspection query or SDL request. */
    var headers: Map = emptyMap()
    /** Boolean flag indicating whether or not selection of deprecated fields is allowed. */
    var allowDeprecatedFields: Boolean = false
    /** List of custom GraphQL scalar to converter mapping containing information about corresponding Java type and converter that should be used to serialize/deserialize values. */
    var customScalars: List = emptyList()
    /** List of query files to be processed. */
    var queryFiles: List = emptyList()
    /** Directory containing GraphQL query files. */
    var queryFileDirectory: String? = null
    /** JSON serializer that will be used to generate the data classes. */
    var serializer: GraphQLSerializer = GraphQLSerializer.JACKSON
    /** Opt-in flag to wrap nullable arguments in OptionalInput that supports both null and undefined. */
    var useOptionalInputWrapper: Boolean = false

    /** Connect and read timeout configuration for executing introspection query/download schema */
    internal val timeoutConfig: TimeoutConfiguration = TimeoutConfiguration()

    fun timeout(action: Action) {
        action.execute(timeoutConfig)
    }

    /** Configure options for parsing GraphQL queries and schema definition language documents. */
    internal val parserOptions: GraphQLParserOptions = GraphQLParserOptions()

    /**
     * Configure options for parsing GraphQL queries and schema definition language documents. Settings
     * here override the defaults set by GraphQL Java.
     */
    fun parserOptions(action: Action) {
        action.execute(parserOptions)
    }
}

open class GraphQLPluginSchemaExtension {
    /** List of supported packages that can contain GraphQL schema type definitions. */
    var packages: List = emptyList()
}

open class GraphQLPluginGraalVmExtension {
    /** List of supported packages that can contain GraphQL schema type definitions. */
    var packages: List = emptyList()
    /** Application main class name. */
    var mainClassName: String? = null
}