feat: Engine shortcut

Author: LSafer

README.md

@@ -56,7 +56,8 @@ fun Application.configureGraphQL() {
     playground() // recommended
 
     graphql {
-        engine(GraphQLJava) {
+        // add import org.cufy.graphkt.java.`graphql-java`
+        `graphql-java` {
             // engine-specific configuration
         }
 

core/src/main/kotlin/GraphktEngine.kt

@@ -71,3 +71,55 @@ interface GraphktEngine {
         local: Map<Any?, Any?> = emptyMap()
     ): Flow<GraphQLResponse>
 }
+
+/**
+ * An interface for builders with graphkt engine.
+ *
+ * Important Note: these interface might change in
+ * the future. It was made to make it easier to
+ * implement features for different kids of tweaks
+ * with less code and not to be used by regular
+ * users.
+ *
+ * @author LSafer
+ * @since 2.0.0
+ */
+interface WithEngine<TConfiguration> {
+    /**
+     * The engine factory.
+     */
+    @AdvancedGraphktApi("Use `engine()` instead")
+    var engineFactory: GraphktEngineFactory<TConfiguration>? // REQUIRED
+
+    /**
+     * Code to be executed to configure the engine.
+     */
+    @AdvancedGraphktApi("Use `engine()` instead")
+    val engineBlock: MutableList<TConfiguration.() -> Unit>
+}
+
+/**
+ * Set the engine factory.
+ *
+ * @param factory the engine factory.
+ * @param block the engine configuration.
+ * @since 2.0.0
+ */
+@OptIn(AdvancedGraphktApi::class)
+fun <TConfiguration> WithEngine<TConfiguration>.engine(
+    factory: GraphktEngineFactory<TConfiguration>,
+    block: TConfiguration.() -> Unit = {}
+) {
+    engineFactory = factory
+    engineBlock += block
+}
+
+/**
+ * Configure the engine with the given [block].
+ */
+@OptIn(AdvancedGraphktApi::class)
+fun <TConfiguration> WithEngine<TConfiguration>.engine(
+    block: TConfiguration.() -> Unit
+) {
+    engineBlock += block
+}

graphql-java/src/main/kotlin/GraphQLJava.kt

@@ -102,3 +102,26 @@ class GraphQLJavaEngine(
         return GraphQLResponse(result)
     }
 }
+
+
+/**
+ * Set the engine factory to be [GraphQLJava].
+ *
+ * @param block the engine configuration.
+ * @since 2.0.0
+ */
+@Suppress("FunctionName")
+fun WithEngine<GraphQLJavaConfiguration>.`graphql-java`(
+    block: GraphQLJavaConfiguration.() -> Unit
+) {
+    engine(GraphQLJava, block)
+}
+
+/**
+ * Set the engine factory to be [GraphQLJava].
+ *
+ * @since 2.0.0
+ */
+@Suppress("ObjectPropertyName")
+val WithEngine<GraphQLJavaConfiguration>.`graphql-java`
+    get() = `graphql-java` {}

ktor/src/main/kotlin/Configuration.kt

@@ -18,6 +18,7 @@ package org.cufy.graphkt.ktor
 import io.ktor.server.application.*
 import org.cufy.graphkt.AdvancedGraphktApi
 import org.cufy.graphkt.GraphktEngineFactory
+import org.cufy.graphkt.WithEngine
 import org.cufy.graphkt.schema.*
 import kotlin.time.Duration
 
@@ -28,7 +29,9 @@ import kotlin.time.Duration
  * @author LSafer
  * @since 2.0.0
  */
-class Configuration<TConfiguration> : WithDeferredBuilder {
+class Configuration<TConfiguration> :
+    WithEngine<TConfiguration>,
+    WithDeferredBuilder {
     /**
      * True, to enable `graphql-ws` implementation.
      *
@@ -43,19 +46,13 @@ class Configuration<TConfiguration> : WithDeferredBuilder {
      */
     var connectionInitWaitTimeout: Duration? = null
 
-    /**
-     * The engine factory.
-     */
     @AdvancedGraphktApi("Use `engine()` instead")
-    var engineFactory: GraphktEngineFactory<TConfiguration>? = null
+    override var engineFactory: GraphktEngineFactory<TConfiguration>? = null
 
     /* blocks */
 
-    /**
-     * Code to be executed to configure the engine.
-     */
     @AdvancedGraphktApi("Use `engine()` instead")
-    val engineBlock: MutableList<TConfiguration.() -> Unit> = mutableListOf()
+    override val engineBlock: MutableList<TConfiguration.() -> Unit> = mutableListOf()
 
     /**
      * Code to be executed to configure the schema.
@@ -98,32 +95,6 @@ fun <TConfiguration> Configuration<TConfiguration>.disableWebsocket() {
     websocket = false
 }
 
-/**
- * Set the engine factory.
- *
- * @param factory the engine factory.
- * @param block the engine configuration.
- * @since 2.0.0
- */
-@OptIn(AdvancedGraphktApi::class)
-fun <TConfiguration> Configuration<TConfiguration>.engine(
-    factory: GraphktEngineFactory<TConfiguration>,
-    block: TConfiguration.() -> Unit = {}
-) {
-    engineFactory = factory
-    engineBlock += block
-}
-
-/**
- * Configure the engine with the given [block].
- */
-@OptIn(AdvancedGraphktApi::class)
-fun <TConfiguration> Configuration<TConfiguration>.engine(
-    block: TConfiguration.() -> Unit
-) {
-    engineBlock += block
-}
-
 /**
  * Configure the schema with the given [block].
  */