5.4.0 release

build.gradle

@@ -9,7 +9,7 @@ plugins {
     id "org.sonarqube" version "3.2.0"
 }
 
-def graphqlCodegenVersion = '5.3.0' // This variable used in the automatic release process
+def graphqlCodegenVersion = '5.4.0' // This variable used in the automatic release process
 
 group = "io.github.kobylynskyi"
 version = graphqlCodegenVersion

docs/codegen-options.md

@@ -56,7 +56,13 @@ See [DirectiveAnnotationsMapping](#option-directiveannotationsmapping)* |
 | `responseProjectionMaxDepth`                          | Integer                                                               | 3                                                      | Sets max depth when use `all$()` which for facilitating the construction of projection automatically, the fields on all projections are provided when it be invoked. This is a global configuration, of course, you can use `all$(max)` to set for each method. For self recursive types, too big depth may result in a large number of returned data!|
 | `generatedLanguage`                                   | Enum                                                                  | GeneratedLanguage.JAVA                                 | Choose which language you want to generate, Java,Scala,Kotlin were supported. Note that due to language features, there are slight differences in default values between languages.|
 | `generateModelOpenClasses`                            | Boolean                                                               | false                                                  | The class type of the generated model. If true, generate normal classes, else generate data classes. It only support in kotlin(```data class```) and scala(```case class```). Maybe we will consider to support Java ```record``` in the future.|
+| `initializeNullableTypes`                             | Boolean                                                               | false                                                  | Adds a default null value to nullable arguments. Only supported in Kotlin.
+| `generateSealedInterfaces`                            | Boolean                                                               | false                                                  | This applies to generated interfaces on unions and interfaces. If true, generate sealed interfaces, else generate normal ones. It is only supported in Kotlin. |
 | `typesAsInterfaces`                                   | Set(String)                                                           | Empty                                                  | Types that must generated as interfaces should be defined here in format: `TypeName` or `@directive`. E.g.: `User`, `@asInterface`. |
+| `useObjectMapperForRequestSerialization`              | Set(String)                                                           | Empty                                                  | Fields that require serialization using `com.fasterxml.jackson.databind.ObjectMapper#writeValueAsString(Object)`. Values should be defined here in the following format: `GraphqlObjectName.fieldName` or `GraphqlTypeName`. If just type is specified, then all fields of this type will be serialized using ObjectMapper. E.g.: `["Person.createdDateTime", ZonedDateTime"]` |
+| `supportUnknownFields`                                | Boolean                                                               | false                                                  | Specifies whether api classes should support unknown fields during serialization or deserialization. If `true`, classes will include a property of type [`java.util.Map<String,Object>`](https://docs.oracle.com/javase/8/docs/api/index.html?java/util/Map.html) that will store unknown fields.|
+| `unknownFieldsPropertyName`                           | String                                                                | userDefinedFields                                      | Specifies the name of the property to be included in api classes to support unknown fields during serialization or deserialization|
+
 
 ### Option `graphqlSchemas`
 

plugins/gradle/README.md

@@ -17,7 +17,7 @@
 
 ```groovy
 plugins {
-  id "io.github.kobylynskyi.graphql.codegen" version "5.3.0"
+  id "io.github.kobylynskyi.graphql.codegen" version "5.4.0"
 }
 ```
 
@@ -31,7 +31,7 @@ buildscript {
     }
   }
   dependencies {
-    classpath "io.github.kobylynskyi.graphql.codegen:graphql-codegen-gradle-plugin:5.3.0"
+    classpath "io.github.kobylynskyi.graphql.codegen:graphql-codegen-gradle-plugin:5.4.0"
   }
 }
 

plugins/gradle/example-client-kotlin/build.gradle

@@ -4,10 +4,10 @@ import io.github.kobylynskyi.graphql.codegen.gradle.GraphQLCodegenGradleTask
 plugins {
     id 'java'
     id "org.jetbrains.kotlin.jvm" version "1.3.71"
-    id "io.github.kobylynskyi.graphql.codegen" version "5.3.0"
+    id "io.github.kobylynskyi.graphql.codegen" version "5.4.0"
 }
 
-def graphqlCodegenClientKotlinVersion = '5.3.0' // Variable used in the automatic release process
+def graphqlCodegenClientKotlinVersion = '5.4.0' // Variable used in the automatic release process
 
 group = 'io.github.dreamylost'
 version = graphqlCodegenClientKotlinVersion
@@ -29,7 +29,7 @@ repositories {
 
 
 dependencies {
-    implementation "io.github.kobylynskyi:graphql-java-codegen:5.3.0"
+    implementation "io.github.kobylynskyi:graphql-java-codegen:5.4.0"
     implementation "javax.validation:validation-api:2.0.1.Final"
     implementation "com.squareup.okhttp3:okhttp:4.2.2"
     implementation "com.fasterxml.jackson.core:jackson-core:2.12.0"
@@ -57,11 +57,13 @@ task graphqlCodegenKotlinService(type: GraphQLCodegenGradleTask) {
     apiPackageName = "io.github.dreamylost.api"
     modelPackageName = "io.github.dreamylost.model"
     generateModelOpenClasses = true
+    generateSealedInterfaces = true
     customAnnotationsMapping = [
             "Character": ["@com.fasterxml.jackson.annotation.JsonTypeInfo(use=com.fasterxml.jackson.annotation.JsonTypeInfo.Id.NAME, include=com.fasterxml.jackson.annotation.JsonTypeInfo.As.PROPERTY,property = \"__typename\")",
                           "@com.fasterxml.jackson.annotation.JsonSubTypes(value = arrayOf(" + System.lineSeparator() +
                                   "       com.fasterxml.jackson.annotation.JsonSubTypes.Type(value = HumanTO::class, name = \"Human\"), " + System.lineSeparator() +
                                   "       com.fasterxml.jackson.annotation.JsonSubTypes.Type(value = DroidTO::class, name = \"Droid\")))"],
     ]
     modelNameSuffix = "TO"
+    supportUnknownFields = true
 }

plugins/gradle/example-client/build.gradle

@@ -7,7 +7,7 @@ plugins {
 
     // use the latest available version:
     // https://plugins.gradle.org/plugin/io.github.kobylynskyi.graphql.codegen
-    id "io.github.kobylynskyi.graphql.codegen" version "5.3.0"
+    id "io.github.kobylynskyi.graphql.codegen" version "5.4.0"
 }
 
 mainClassName = "io.github.kobylynskyi.order.Application"
@@ -22,7 +22,7 @@ dependencies {
 
     // use the latest available version:
     // https://search.maven.org/artifact/io.github.kobylynskyi/graphql-java-codegen
-    implementation "io.github.kobylynskyi:graphql-java-codegen:5.3.0"
+    implementation "io.github.kobylynskyi:graphql-java-codegen:5.4.0"
 
     implementation "org.apache.httpcomponents:httpclient:4.5.13"
     implementation "javax.validation:validation-api:2.0.1.Final"

plugins/gradle/example-server/build.gradle

@@ -6,7 +6,7 @@ plugins {
     //
     // use the latest available version:
     // https://plugins.gradle.org/plugin/io.github.kobylynskyi.graphql.codegen
-    id "io.github.kobylynskyi.graphql.codegen" version "5.3.0"
+    id "io.github.kobylynskyi.graphql.codegen" version "5.4.0"
 }
 
 mainClassName = "io.github.kobylynskyi.product.Application"
@@ -48,6 +48,9 @@ graphqlCodegen {
     }
     modelNameSuffix = "TO"
     generateApis = true
+    supportUnknownFields = true
+    unknownFieldsPropertyName = "additionalFields"
+
 }
 
 repositories {

plugins/gradle/example-server/src/main/java/io/github/kobylynskyi/product/Application.java

@@ -6,6 +6,7 @@
 @SpringBootApplication
 public class Application {
 
+
     public static void main(String[] args) {
         SpringApplication.run(Application.class, args);
     }

plugins/gradle/graphql-java-codegen-gradle-plugin/build.gradle

@@ -16,7 +16,7 @@ apply plugin: "java"
 apply plugin: "idea"
 apply plugin: "maven-publish"
 
-def graphqlCodegenGradlePluginVersion = '5.3.0' // This variable used in the automatic release process
+def graphqlCodegenGradlePluginVersion = '5.4.0' // This variable used in the automatic release process
 
 group = "io.github.kobylynskyi"
 version = graphqlCodegenGradlePluginVersion

plugins/gradle/graphql-java-codegen-gradle-plugin/src/main/java/io/github/kobylynskyi/graphql/codegen/gradle/GraphQLCodegenGradleTask.java

@@ -103,6 +103,11 @@ public class GraphQLCodegenGradleTask extends DefaultTask implements GraphQLCode
     private List<String> configurationFiles;
     private GeneratedLanguage generatedLanguage = MappingConfigConstants.DEFAULT_GENERATED_LANGUAGE;
     private Boolean generateModelOpenClasses = MappingConfigConstants.DEFAULT_GENERATE_MODEL_OPEN_CLASSES;
+    private Boolean initializeNullableTypes = MappingConfigConstants.DEFAULT_INITIALIZE_NULLABLE_TYPES;
+    private Boolean generateSealedInterfaces = MappingConfigConstants.DEFAULT_GENERATE_SEALED_INTERFACES;
+
+    private Boolean supportUnknownFields = MappingConfigConstants.DEFAULT_SUPPORT_UNKNOWN_FIELDS;
+    private String unknownFieldsPropertyName = MappingConfigConstants.DEFAULT_UNKNOWN_FIELDS_PROPERTY_NAME;
 
     public GraphQLCodegenGradleTask() {
         setGroup("codegen");
@@ -178,6 +183,10 @@ public void generate() throws Exception {
 
         mappingConfig.setGeneratedLanguage(generatedLanguage);
         mappingConfig.setGenerateModelOpenClasses(generateModelOpenClasses);
+        mappingConfig.setInitializeNullableTypes(initializeNullableTypes);
+
+        mappingConfig.setSupportUnknownFields(isSupportUnknownFields());
+        mappingConfig.setUnknownFieldsPropertyName(getUnknownFieldsPropertyName());
 
         instantiateCodegen(mappingConfig).generate();
     }
@@ -844,4 +853,50 @@ public Boolean isGenerateModelOpenClasses() {
     public void setGenerateModelOpenClasses(Boolean generateModelOpenClasses) {
         this.generateModelOpenClasses = generateModelOpenClasses;
     }
+
+    @Input
+    @Optional
+    @Override
+    public Boolean isInitializeNullableTypes() {
+        return initializeNullableTypes;
+    }
+
+    public void setInitializeNullableTypes(Boolean initializeNullableTypes) {
+        this.initializeNullableTypes = initializeNullableTypes;
+    }
+
+    @Input
+    @Optional
+    @Override
+    public Boolean isGenerateSealedInterfaces() {
+        return generateSealedInterfaces;
+    }
+
+    public void setGenerateSealedInterfaces(Boolean generateSealedInterfaces) {
+        this.generateSealedInterfaces = generateSealedInterfaces;
+    }
+
+    @Input
+    @Optional
+    @Override
+    public Boolean isSupportUnknownFields() {
+        return supportUnknownFields;
+    }
+
+    public void setSupportUnknownFields(boolean supportUnknownFields) {
+        this.supportUnknownFields = supportUnknownFields;
+    }
+
+    @Input
+    @Optional
+    @Override
+    public String getUnknownFieldsPropertyName() {
+        return unknownFieldsPropertyName;
+    }
+
+    public void setUnknownFieldsPropertyName(String unknownFieldsPropertyName) {
+        this.unknownFieldsPropertyName = unknownFieldsPropertyName;
+    }
+
+
 }

plugins/maven/README.md

@@ -20,7 +20,7 @@
         <plugin>
             <groupId>io.github.kobylynskyi</groupId>
             <artifactId>graphql-codegen-maven-plugin</artifactId>
-            <version>5.3.0</version>
+            <version>5.4.0</version>
             <executions>
                 <execution>
                     <goals>

plugins/maven/example-client/pom.xml

@@ -4,7 +4,7 @@
 
     <groupId>io.github.kobylynskyi</groupId>
     <artifactId>graphql-codegen-maven-plugin-example-client</artifactId>
-    <version>5.3.0</version>
+    <version>5.4.0</version>
     <name>graphql-codegen-maven-plugin-example-client</name>
 
     <build>

plugins/maven/example-server/pom.xml

@@ -4,7 +4,7 @@
 
     <groupId>io.github.kobylynskyi</groupId>
     <artifactId>graphql-codegen-maven-plugin-example-server</artifactId>
-    <version>5.3.0</version>
+    <version>5.4.0</version>
     <name>graphql-codegen-maven-plugin-example-server</name>
 
     <build>

plugins/maven/graphql-java-codegen-maven-plugin/pom.xml

@@ -3,7 +3,7 @@
 
     <groupId>io.github.kobylynskyi</groupId>
     <artifactId>graphql-codegen-maven-plugin</artifactId>
-    <version>5.3.1-SNAPSHOT</version>
+    <version>5.4.0</version>
     <packaging>maven-plugin</packaging>
 
     <name>graphql-codegen-maven-plugin</name>
@@ -72,7 +72,7 @@
         <version.maven-gpg-plugin>3.0.1</version.maven-gpg-plugin>
         <version.maven-shared-utils>3.3.4</version.maven-shared-utils>
 
-        <version.graphql-java-codegen>5.3.0</version.graphql-java-codegen>
+        <version.graphql-java-codegen>5.4.0</version.graphql-java-codegen>
     </properties>
 
     <dependencies>

plugins/maven/graphql-java-codegen-maven-plugin/src/main/java/io/github/kobylynskyi/graphql/codegen/GraphQLCodegenMojo.java

@@ -200,6 +200,12 @@ public class GraphQLCodegenMojo extends AbstractMojo implements GraphQLCodegenCo
     @Parameter
     private String[] configurationFiles;
 
+    @Parameter(defaultValue = MappingConfigConstants.DEFAULT_SUPPORT_UNKNOWN_FIELDS_STRING)
+    private boolean supportUnknownFields;
+
+    @Parameter(defaultValue = MappingConfigConstants.DEFAULT_UNKNOWN_FIELDS_PROPERTY_NAME)
+    private String unknownFieldsPropertyName;
+
     /**
      * The project being built.
      */
@@ -209,6 +215,12 @@ public class GraphQLCodegenMojo extends AbstractMojo implements GraphQLCodegenCo
     @Parameter(defaultValue = MappingConfigConstants.DEFAULT_GENERATE_MODEL_OPEN_CLASSES_STRING)
     private boolean generateModelOpenClasses;
 
+    @Parameter(defaultValue = MappingConfigConstants.DEFAULT_INITIALIZE_NULLABLE_TYPES_STRING)
+    private boolean initializeNullableTypes;
+
+    @Parameter(defaultValue = MappingConfigConstants.DEFAULT_GENERATE_SEALED_INTERFACES_STRING)
+    private boolean generateSealedInterfaces;
+
     @Override
     public void execute() throws MojoExecutionException {
         addCompileSourceRootIfConfigured();
@@ -267,6 +279,11 @@ public void execute() throws MojoExecutionException {
 
         mappingConfig.setGeneratedLanguage(generatedLanguage);
         mappingConfig.setGenerateModelOpenClasses(isGenerateModelOpenClasses());
+        mappingConfig.setInitializeNullableTypes(isInitializeNullableTypes());
+        mappingConfig.setGenerateSealedInterfaces(isGenerateSealedInterfaces());
+
+        mappingConfig.setSupportUnknownFields(isSupportUnknownFields());
+        mappingConfig.setUnknownFieldsPropertyName(getUnknownFieldsPropertyName());
 
         try {
             instantiateCodegen(mappingConfig).generate();
@@ -603,6 +620,16 @@ public Boolean isGenerateModelOpenClasses() {
         return generateModelOpenClasses;
     }
 
+    @Override
+    public Boolean isInitializeNullableTypes() {
+        return initializeNullableTypes;
+    }
+
+    @Override
+    public Boolean isGenerateSealedInterfaces() {
+        return generateSealedInterfaces;
+    }
+
     public ParentInterfacesConfig getParentInterfaces() {
         return parentInterfaces;
     }
@@ -611,6 +638,24 @@ public String[] getConfigurationFiles() {
         return configurationFiles;
     }
 
+    @Override
+    public Boolean isSupportUnknownFields() {
+        return supportUnknownFields;
+    }
+
+    public void setSupportUnknownFields(boolean supportUnknownFields) {
+        this.supportUnknownFields = supportUnknownFields;
+    }
+
+    @Override
+    public String getUnknownFieldsPropertyName() {
+        return unknownFieldsPropertyName;
+    }
+
+    public void setUnknownFieldsPropertyName(String unknownFieldsPropertyName) {
+        this.unknownFieldsPropertyName = unknownFieldsPropertyName;
+    }
+
     private static Map<String, List<String>> convertToListsMap(Map<String, Properties> sourceMap) {
         if (sourceMap == null) {
             return new HashMap<>();

plugins/sbt/graphql-java-codegen-sbt-plugin/src/main/scala/io/github/dreamylost/graphql/codegen/GraphQLCodegenKeys.scala

@@ -124,6 +124,8 @@ trait GraphQLCodegenKeys {
 
   val generateModelOpenClasses = settingKey[Boolean]("The class type of the generated model. If true, generate normal classes, else generate case class.")
 
+  val generateSealedInterfaces = settingKey[Boolean]("If true, generate sealed interfaces for GraphQL unions and interfaces, else generate normal interfaces.")
+
   val generateJacksonTypeIdResolver = settingKey[Boolean]("Specifies whether generated union interfaces should be annotated with a custom Jackson type id resolver generated in model package")
 
   //for version
@@ -133,4 +135,7 @@ trait GraphQLCodegenKeys {
   //some others for sbt
   val generateCodegenTargetPath = settingKey[File]("Where to store generated files and add the generated code to the classpath, so that they can be referenced.")
 
+  val supportUnknownFields = settingKey[Boolean]("supportUnknownFields")
+  val unknownFieldsPropertyName = settingKey[String]("unknownFieldsPropertyName")
+
 }

plugins/sbt/graphql-java-codegen-sbt-plugin/src/main/scala/io/github/dreamylost/graphql/codegen/GraphQLCodegenPlugin.scala

@@ -71,6 +71,7 @@ class GraphQLCodegenPlugin(configuration: Configuration, private[codegen] val co
     graphqlJavaCodegenVersion := None,
     // suffix/prefix/strategies:
     generateModelOpenClasses := MappingConfigConstants.DEFAULT_GENERATE_MODEL_OPEN_CLASSES,
+    generateSealedInterfaces := MappingConfigConstants.DEFAULT_GENERATE_SEALED_INTERFACES,
     generatedLanguage := MappingConfigConstants.DEFAULT_GENERATED_LANGUAGE,
     apiNamePrefix := None,
     apiNameSuffix := MappingConfigConstants.DEFAULT_RESOLVER_SUFFIX,
@@ -116,7 +117,10 @@ class GraphQLCodegenPlugin(configuration: Configuration, private[codegen] val co
     // parent interfaces configs:
     parentInterfaces := parentInterfacesConfig,
     generateAllMethodInProjection := MappingConfigConstants.DEFAULT_GENERATE_ALL_METHOD,
-    responseProjectionMaxDepth := MappingConfigConstants.DEFAULT_RESPONSE_PROJECTION_MAX_DEPTH
+    responseProjectionMaxDepth := MappingConfigConstants.DEFAULT_RESPONSE_PROJECTION_MAX_DEPTH,
+
+    supportUnknownFields := MappingConfigConstants.DEFAULT_SUPPORT_UNKNOWN_FIELDS,
+    unknownFieldsPropertyName := MappingConfigConstants.DEFAULT_UNKNOWN_FIELDS_PROPERTY_NAME
   )
 
   private def getMappingConfig(): Def.Initialize[MappingConfig] = Def.setting {
@@ -171,6 +175,10 @@ class GraphQLCodegenPlugin(configuration: Configuration, private[codegen] val co
     mappingConfig.setGeneratedLanguage((generatedLanguage in GraphQLCodegenConfig).value)
     mappingConfig.setGenerateModelOpenClasses((generateModelOpenClasses in GraphQLCodegenConfig).value)
     mappingConfig.setGenerateJacksonTypeIdResolver((generateJacksonTypeIdResolver in GraphQLCodegenConfig).value);
+
+    mappingConfig.setSupportUnknownFields((supportUnknownFields in GraphQLCodegenConfig).value)
+    mappingConfig.setUnknownFieldsPropertyName((unknownFieldsPropertyName in GraphQLCodegenConfig).value)
+
     mappingConfig
   }
 

plugins/sbt/graphql-java-codegen-sbt-plugin/src/sbt-test/graphql-codegen-sbt-plugin/example-client-scala/project/plugins.sbt

@@ -1 +1 @@
-addSbtPlugin("io.github.jxnu-liguobin" % "graphql-codegen-sbt-plugin" % "5.3.0")
+addSbtPlugin("io.github.jxnu-liguobin" % "graphql-codegen-sbt-plugin" % "5.4.0")

plugins/sbt/graphql-java-codegen-sbt-plugin/src/sbt-test/graphql-codegen-sbt-plugin/example-client-scala/version.sbt

@@ -1 +1 @@
-version in ThisBuild := "5.3.0"
+version in ThisBuild := "5.4.0"

plugins/sbt/graphql-java-codegen-sbt-plugin/src/sbt-test/graphql-codegen-sbt-plugin/example-client/project/plugins.sbt

@@ -1 +1 @@
-addSbtPlugin("io.github.jxnu-liguobin" % "graphql-codegen-sbt-plugin" % "5.3.0")
+addSbtPlugin("io.github.jxnu-liguobin" % "graphql-codegen-sbt-plugin" % "5.4.0")

plugins/sbt/graphql-java-codegen-sbt-plugin/src/sbt-test/graphql-codegen-sbt-plugin/example-client/version.sbt

@@ -1 +1 @@
-version in ThisBuild := "5.3.0"
+version in ThisBuild := "5.4.0"

plugins/sbt/graphql-java-codegen-sbt-plugin/src/sbt-test/graphql-codegen-sbt-plugin/simple/project/plugins.sbt

@@ -1,4 +1,4 @@
-sys.props.get("plugin.version").orElse(Some("5.3.0")) match {
+sys.props.get("plugin.version").orElse(Some("5.4.0")) match {
   case Some(x) => addSbtPlugin("io.github.jxnu-liguobin" % "graphql-codegen-sbt-plugin" % x)
   case _ => sys.error("""|The system property 'plugin.version' is not defined.
                          |Specify this property using the scriptedLaunchOpts -D.""".stripMargin)

plugins/sbt/graphql-java-codegen-sbt-plugin/src/sbt-test/graphql-codegen-sbt-plugin/simple/version.sbt

@@ -1 +1 @@
-version in ThisBuild := "5.3.0"
+version in ThisBuild := "5.4.0"