# Installation

Below is an overall list of steps which we'd take to integrate suparnatural-graphql in a Kotlin Multiplatform project.

1. Configure kotlinx.serialization
2. Apply the graphql-plugin.
3. Configure the plugin with options like GraphQL server endpoint to fetch schema.
4. Add common and platform specific graphql dependencies to the project.
5. Add rx runtime provider.

# Kotlinx Serialization

To parse JSON, this library depends on kotlinx.serialization. Follow this guide to configure it.

# Apply Gradle Plugin

Configure buildscript section of your build.gradle.kts or build.gradle with following.

buildscript {
    repositories {
        mavenCentral()
    }
    dependencies {
        classpath("com.suparnatural.kotlin:graphql-plugin:1.0.12")
    }
}

apply(plugin="com.suparnatural.plugins.graphql")

buildscript {
    repositories {
        mavenCentral()
    }
    dependencies {
        classpath "com.suparnatural.kotlin:graphql-plugin:1.0.0"
    }
}

apply plugin: "com.suparnatural.kotlin.graphql"

# Configure Gradle Plugin

Add the following to your build.gradle.kts or build.gradle file

suparnaturalGraphQl {
    packageName = "com.myapp.graphql.models"
    endpointUrl = "https://countries.trevorblades.com"
    documentsPath = "operations/*.gql"
    outputDirectoryPath = "src/main/kotlin"
    headers = listOf("Authorization: abc")
}

suparnaturalGraphQl {
    packageName = "com.myapp.graphql.models"
    endpointUrl = "https://countries.trevorblades.com"
    documentsPath = "operations/*.gql"
    outputDirectoryPath = "src/main/kotlin"
    headers = ["Authorization: abc"]
}

# Add Library

Add the maven repository to repositories block.

repositories {
    mavenCentral()
}

repositories {
    mavenCentral()
}

Add the following to your commonMain target.

commonMain {
    dependencies {
        implementation("com.suparnatural.kotlin:graphql:version")
    }
}

commonMain {
    dependencies {
        implementation "com.suparnatural.kotlin:graphql:version"
    }
}

With the hierarchical project structure, you generally need to add the dependency to commonMain only. Other targets are also available in case you need to override this behavior.

Finally, run the gradle task graphQlCodeGen under group suparnatural.

# RX Runtime

The response from GraphQL is exposed as an Observable and therefore, the library needs an RX runtime. The RxRuntimeProvider class provides the RX runtime to the rest of the library. A minimal RX runtime is provided by suparnatural:rx-runtime-reaktive package which uses Reaktive internally. Add the following code to build.gradle to include the required repository.

repositories {
    maven(url="https://dl.bintray.com/badoo/maven")
}

repositories {
    maven {
        url "https://dl.bintray.com/badoo/maven"
    }
}

Next, configure each source set with the appropriate dependency

Next, initialize the runtime in your application

fun main() {
    RxRuntimeProvider.observableFactory = ReaktiveObservableFactory()
    RxRuntimeProvider.publishSubjectFactory = ReaktivePublishSubjectFactory()
}

# Custom RX Runtime

If you are already using an rx library or you want more than rx-runtime-reaktive, you can also provide your custom runtime. Add the rx definition as a dependency so that you can access the right interfaces. As before, pick the right dependency for the target and add it to the source set.

commonMain {
    dependencies {
        implementation("com.suparnatural.kotlin:rx:version")
    }
}

commonMain {
    dependencies {
        implementation "com.suparnatural.kotlin:rx:version"
    }
}

Next, initialize the runtime in your application

fun main() {
    RxRuntimeProvider.observableFactory = CustomObservableFactory()
    RxRuntimeProvider.publishSubjectFactory = CustomPublishSubjectFactory()
}