Merge pull request #9 from lsafer-meemer/main

maintenance 2

Author: lsafer-meemer

README.md

@@ -35,17 +35,17 @@ data class Entity(
 )
 
 val EntityObjectType: GraphQLObjectType<Entity> = GraphQLObjectType {
-    name("Entity")
-    description { "Some entity." }
+    name = "Entity"
+    description = "Some entity."
 
     field(Entity::name) {
+        description = "The name of the entity."
         type { GraphQLStringType }
-        description { "The name of the entity." }
     }
 
     field("nameWithCustomVar") {
+        description = "The name of the entity with the customVar in the context."
         type { GraphQLStringType.Nullable }
-        description { "The name of the entity with the customVar in the context." }
 
         get {
             it.name + context["myCustomVar"]
@@ -58,8 +58,8 @@ val EntitiesFlow = MutableSharedFlow<Entity>()
 fun Application.configureGraphQL() {
     // you can choose any of these IDEs
     // graphiql()
-    // sandbox()
-    playground() // recommended
+    // apolloSandbox()
+    graphqlPlayground() // recommended
 
     graphql {
         // add import org.cufy.graphkt.java.`graphql-java`
@@ -73,30 +73,30 @@ fun Application.configureGraphQL() {
 
         schema {
             query {
-                description { "The root query." }
+                description = "The root query."
 
                 field("getEntityWithName") {
+                    description = "Get an entity instance."
                     type { EntityObjectType }
-                    description { "Get an entity instance." }
 
                     val nameArg = argument<String>("name") {
+                        description = "The name of the entity."
                         type { GraphQLStringType }
-                        description { "The name of the entity." }
                     }
 
                     get { Entity(nameArg()) }
                 }
             }
             mutation {
-                description { "The root mutation" }
+                description = "The root mutation"
 
                 field("pushEntity") {
+                    description = "Push an entity to subscribers"
                     type { EntityObjectType }
-                    description { "Push an entity to subscribers" }
 
                     val nameArg = argument<String>("name") {
+                        description = "The name of the entity."
                         type { GraphQLStringType }
-                        description { "The name of the entity." }
                     }
 
                     get {
@@ -107,11 +107,11 @@ fun Application.configureGraphQL() {
                 }
             }
             subscription {
-                description { "The root subscription" }
+                description = "The root subscription"
 
                 field("subscribeToEntities") {
+                    description = "Subscribe to pushed entities"
                     type { EntityObjectType }
-                    description { "Subscribe to pushed entities" }
 
                     getFlow { EntitiesFlow }
                 }

graphkt-core/src/commonMain/kotlin/Annotations.kt

@@ -15,22 +15,6 @@
  */
 package org.cufy.graphkt
 
-/**
- * Marks the annotated component as internal.
- *
- * @since 2.0.0
- */
-@RequiresOptIn(
-    message = "This is an internal API and was not designed to be used directly",
-    level = RequiresOptIn.Level.ERROR
-)
-annotation class InternalGraphktApi(
-    /**
-     * Optionally, the reason why the component was marked with this annotation.
-     */
-    val reason: String = "This is an internal API and was not designed to be used directly"
-)
-
 /**
  * Marks the annotated component as experimental.
  *
@@ -40,31 +24,4 @@ annotation class InternalGraphktApi(
     message = "This is an experimental API and might change at anytime",
     level = RequiresOptIn.Level.WARNING
 )
-annotation class ExperimentalGraphktApi(
-    /**
-     * Optionally, the reason why the component was marked with this annotation.
-     */
-    val reason: String = "This is an experimental API and might change at anytime"
-)
-
-/**
- * Marks the annotated component as advanced.
- *
- * Components marked by this annotation are meant
- * to be used in libraries and not application code.
- *
- * This was put to avoid users getter into stuff
- * that needs more reading by accident.
- *
- * @since 2.0.0
- */
-@RequiresOptIn(
-    message = "This API is meant to be used to extend the functionality of graphkt",
-    level = RequiresOptIn.Level.WARNING
-)
-annotation class AdvancedGraphktApi(
-    /**
-     * Optionally, the reason why the component was marked with this annotation.
-     */
-    val reason: String = "This API is meant to be used to extend the functionality of graphkt"
-)
+annotation class ExperimentalGraphktApi

graphkt-core/src/commonMain/kotlin/GraphQLEngine.kt

@@ -27,13 +27,15 @@ import java.io.Reader
  * @author LSafer
  * @since 2.0.0
  */
+@ExperimentalGraphktApi
 interface GraphQLEngineFactory {
     /**
      * Create a new engine instance.
      *
      * @param schema the engine's schema.
      * @since 2.0.0
      */
+    @ExperimentalGraphktApi
     operator fun invoke(schema: GraphQLSchema): GraphQLEngine
 }
 
@@ -44,10 +46,12 @@ interface GraphQLEngineFactory {
  * @author LSafer
  * @since 2.0.0
  */
+@ExperimentalGraphktApi
 interface GraphQLEngine {
     /**
      * Obtain a reader that reads the schema definition.
      */
+    @ExperimentalGraphktApi
     fun obtainSchemaReader(): Reader
 
     /**
@@ -58,6 +62,7 @@ interface GraphQLEngine {
      * @param local the initial local.
      * @since 2.0.0
      */
+    @ExperimentalGraphktApi
     fun execute(
         request: GraphQLRequest,
         context: Map<Any?, Any?> = emptyMap(),
@@ -81,6 +86,7 @@ interface GraphQLElementWithEngine {
     /**
      * The engine factory.
      */
+    @ExperimentalGraphktApi
     val engine: GraphQLEngineFactory
 }
 
@@ -99,5 +105,6 @@ interface GraphQLElementWithEngine {
 interface GraphQLMutableElementWithEngine
     : GraphQLElementWithEngine {
 
+    @ExperimentalGraphktApi
     override /* lateinit */ var engine: GraphQLEngineFactory
 }

graphkt-core/src/commonMain/kotlin/schema/Builtins.kt

@@ -21,8 +21,8 @@ import java.math.BigInteger
 //
 
 private val GraphQLDeprecatedReasonArgument = GraphQLArgumentDefinition("reason") {
+    description = "The reason for the deprecation."
     type { GraphQLStringType }
-    description { "The reason for the deprecation." }
 }
 
 /**
@@ -31,7 +31,7 @@ private val GraphQLDeprecatedReasonArgument = GraphQLArgumentDefinition("reason"
  * @since 2.0.0
  */
 val GraphQLDeprecatedDirective = GraphQLDirectiveDefinition("deprecated") {
-    description { "Marks the field, argument, input field or enum value as deprecated." }
+    description = "Marks the field, argument, input field or enum value as deprecated."
     argument(GraphQLDeprecatedReasonArgument)
     location(GraphQLDirectiveLocation.FIELD_DEFINITION)
     location(GraphQLDirectiveLocation.ENUM_VALUE)
@@ -40,8 +40,8 @@ val GraphQLDeprecatedDirective = GraphQLDirectiveDefinition("deprecated") {
 }
 
 private val GraphQLSpecifiedByUrlArgument = GraphQLArgumentDefinition("url") {
+    description = "The URL that specifies the behaviour of this scalar."
     type { GraphQLStringType }
-    description { "The URL that specifies the behaviour of this scalar." }
 }
 
 /**
@@ -50,7 +50,7 @@ private val GraphQLSpecifiedByUrlArgument = GraphQLArgumentDefinition("url") {
  * @since 2.0.0
  */
 val GraphQLSpecifiedByDirective = GraphQLDirectiveDefinition("specifiedBy") {
-    description { "Exposes a URL that specifies the behaviour of this scalar." }
+    description = "Exposes a URL that specifies the behaviour of this scalar."
     argument(GraphQLSpecifiedByUrlArgument)
     location(GraphQLDirectiveLocation.SCALAR)
 }
@@ -59,10 +59,10 @@ val GraphQLSpecifiedByDirective = GraphQLDirectiveDefinition("specifiedBy") {
  * Directs the executor to include this field or fragment only when the `if` argument is true.
  */
 val GraphQLIncludeDirective = GraphQLDirectiveDefinition("include") {
-    description { "Directs the executor to include this field or fragment only when the `if` argument is true." }
+    description = "Directs the executor to include this field or fragment only when the `if` argument is true."
     argument("if") {
+        description = "Included when true."
         type { GraphQLBooleanType }
-        description { "Included when true." }
     }
     location(GraphQLDirectiveLocation.FRAGMENT_SPREAD)
     location(GraphQLDirectiveLocation.INLINE_FRAGMENT)
@@ -73,10 +73,10 @@ val GraphQLIncludeDirective = GraphQLDirectiveDefinition("include") {
  * Directs the executor to skip this field or fragment when the `if`'argument is true.
  */
 val GraphQLSkipDirective = GraphQLDirectiveDefinition("skip") {
-    description { "Directs the executor to skip this field or fragment when the `if`'argument is true." }
+    description = "Directs the executor to skip this field or fragment when the `if`'argument is true."
     argument("if") {
+        description = "Skipped when true."
         type { GraphQLBooleanType }
-        description { "Skipped when true." }
     }
     location(GraphQLDirectiveLocation.FRAGMENT_SPREAD)
     location(GraphQLDirectiveLocation.INLINE_FRAGMENT)
@@ -117,7 +117,7 @@ fun GraphQLMutableElementWithDirectives.specifiedBy(url: String) {
  * @since 2.0.0
  */
 val GraphQLIntType: GraphQLScalarType<Int> = GraphQLScalarType("Int") {
-    description { "Built-in Int (32-bit)" }
+    description = "Built-in Int (32-bit)"
     decode {
         require(it is GraphQLInteger) {
             "Expected GraphQLInteger but got ${it.javaClass.simpleName}"
@@ -135,7 +135,7 @@ val GraphQLIntType: GraphQLScalarType<Int> = GraphQLScalarType("Int") {
  * @since 2.0.0
  */
 val GraphQLFloatType: GraphQLScalarType<Double> = GraphQLScalarType("Float") {
-    description { "Built-in Float (64-bit)" }
+    description = "Built-in Float (64-bit)"
     decode {
         when (it) {
             is GraphQLDecimal -> it.value.toDouble()
@@ -157,7 +157,7 @@ val GraphQLFloatType: GraphQLScalarType<Double> = GraphQLScalarType("Float") {
  * @since 2.0.0
  */
 val GraphQLStringType: GraphQLScalarType<String> = GraphQLScalarType("String") {
-    description { "Built-in String" }
+    description = "Built-in String"
     decode {
         require(it is GraphQLString) {
             "Expected GraphQLString but got ${it.javaClass.simpleName}"
@@ -175,7 +175,7 @@ val GraphQLStringType: GraphQLScalarType<String> = GraphQLScalarType("String") {
  * @since 2.0.0
  */
 val GraphQLBooleanType: GraphQLScalarType<Boolean> = GraphQLScalarType("Boolean") {
-    description { "Built-in Boolean" }
+    description = "Built-in Boolean"
     decode {
         require(it is GraphQLBoolean) {
             "Expected GraphQLBoolean but got ${it.javaClass.simpleName}"
@@ -193,7 +193,7 @@ val GraphQLBooleanType: GraphQLScalarType<Boolean> = GraphQLScalarType("Boolean"
  * @since 2.0.0
  */
 val GraphQLIDType: GraphQLScalarType<String> = GraphQLScalarType("ID") {
-    description { "Built-in ID" }
+    description = "Built-in ID"
     decode {
         require(it is GraphQLString) {
             "Expected GraphQLString but got ${it.javaClass.simpleName}"
@@ -213,8 +213,8 @@ val GraphQLIDType: GraphQLScalarType<String> = GraphQLScalarType("ID") {
  * @since 2.0.0
  */
 val GraphQLLongType: GraphQLScalarType<Long> = GraphQLScalarType("Long") {
+    description = "Long"
     specifiedBy("https://github.com")
-    description { "Long" }
     decode {
         require(it is GraphQLInteger) {
             "Expected GraphQLInteger but got ${it.javaClass.simpleName}"
@@ -232,7 +232,7 @@ val GraphQLLongType: GraphQLScalarType<Long> = GraphQLScalarType("Long") {
  * @since 2.0.0
  */
 val GraphQLDecimalType: GraphQLScalarType<BigDecimal> = GraphQLScalarType("Decimal") {
-    description { "Decimal" }
+    description = "Decimal"
     decode {
         when (it) {
             is GraphQLDecimal -> it.value
@@ -253,7 +253,7 @@ val GraphQLDecimalType: GraphQLScalarType<BigDecimal> = GraphQLScalarType("Decim
  * @since 2.0.0
  */
 val GraphQLIntegerType: GraphQLScalarType<BigInteger> = GraphQLScalarType("Integer") {
-    description { "Integer" }
+    description = "Integer"
     decode {
         require(it is GraphQLInteger) {
             "Expected GraphQLInteger but got ${it.javaClass.simpleName}"
@@ -270,8 +270,8 @@ val GraphQLIntegerType: GraphQLScalarType<BigInteger> = GraphQLScalarType("Integ
  *
  * @since 2.0.0
  */
-val GraphQLVoidType = GraphQLScalarType<Unit>("Void") {
-    description { "Void" }
+val GraphQLVoidType = GraphQLScalarType("Void") {
+    description = "Void"
     decode { }
     encode { GraphQLBoolean(true) }
 }

graphkt-core/src/commonMain/kotlin/schema/Definitions.kt

@@ -294,6 +294,8 @@ fun GraphQLDirective(
  *
  * This will replace the current definition.
  */
+@Suppress("DeprecatedCallableAddReplaceWith")
+@Deprecated("replace with `this.definition = definition`")
 fun GraphQLMutableDirective.definition(
     definition: GraphQLDirectiveDefinition
 ) {
@@ -444,6 +446,8 @@ fun GraphQLMutableDirectiveDefinition.location(
 /**
  * Set the repeatable property to the given [value].
  */
+@Suppress("DeprecatedCallableAddReplaceWith")
+@Deprecated("replace with `this.repeatable = value`")
 fun GraphQLMutableDirectiveDefinition.repeatable(
     value: Boolean = true
 ) {
@@ -828,7 +832,9 @@ fun <T : Any, M> GraphQLMutableFieldDefinition(): GraphQLMutableFieldDefinition<
         override val arguments = mutableListOf<GraphQLArgumentDefinition<*>>()
         override val onGetBlocks = mutableListOf<GraphQLGetterBlock<T, M>>()
         override val onGetBlockingBlocks = mutableListOf<GraphQLGetterBlockingBlock<T, M>>()
-        override var getter: GraphQLFlowGetter<T, M> = { throw NotImplementedError("Getter of field $name was not implemented.") }
+        override var getter: GraphQLFlowGetter<T, M> = {
+            throw NotImplementedError("Getter of field $name was not implemented.")
+        }
     }
 }
 
@@ -1405,7 +1411,9 @@ fun <T : Any> GraphQLMutableInterfaceType(): GraphQLMutableInterfaceType<T> {
         override val onGetBlocks = mutableListOf<GraphQLGetterBlock<T, *>>()
         override val onGetBlockingBlocks = mutableListOf<GraphQLGetterBlockingBlock<T, *>>()
         override val fields = mutableListOf<GraphQLFieldDefinition<T, *>>()
-        override var typeGetter: GraphQLTypeGetter<T> = { throw NotImplementedError("Type getter of interface $name was not implemented.") }
+        override var typeGetter: GraphQLTypeGetter<T> = {
+            throw NotImplementedError("Type getter of interface $name was not implemented.")
+        }
     }
 }
 
@@ -2075,7 +2083,9 @@ fun <T : Any> GraphQLMutableUnionType(): GraphQLMutableUnionType<T> {
         override lateinit var name: String
         override var description: String = ""
         override val directives = mutableListOf<GraphQLDirective>()
-        override var typeGetter: GraphQLTypeGetter<T> = { throw NotImplementedError("Type getter of union $name was not implemented.") }
+        override var typeGetter: GraphQLTypeGetter<T> = {
+            throw NotImplementedError("Type getter of union $name was not implemented.")
+        }
         override val types = mutableListOf<GraphQLObjectType<out T>>()
     }
 }