fix(dart): preserve nullable nested array item types and decoding

Author: timonrieger

modules/openapi-generator/src/main/java/org/openapitools/codegen/languages/AbstractDartCodegen.java

@@ -524,13 +524,17 @@ public String toDefaultValue(Schema schema) {
 
     @Override
     public String getTypeDeclaration(Schema p) {
+        return getTypeDeclaration(p, false);
+    }
+
+    private String getTypeDeclaration(Schema p, boolean includeNullableSuffix) {
         Schema<?> schema = unaliasSchema(p);
         Schema<?> target = ModelUtils.isGenerateAliasAsModel() ? p : schema;
+        String typeDeclaration;
         if (ModelUtils.isArraySchema(target)) {
             Schema<?> items = ModelUtils.getSchemaItems(schema);
-            return getSchemaType(target) + "<" + getTypeDeclaration(items) + ">";
-        }
-        if (ModelUtils.isMapSchema(target)) {
+            typeDeclaration = getSchemaType(target) + "<" + getTypeDeclaration(items, true) + ">";
+        } else if (ModelUtils.isMapSchema(target)) {
             // Note: ModelUtils.isMapSchema(p) returns true when p is a composed schema that also defines
             // additionalproperties: true
             Schema<?> inner = ModelUtils.getAdditionalProperties(target);
@@ -539,9 +543,16 @@ public String getTypeDeclaration(Schema p) {
                 inner = new StringSchema().description("TODO default missing map inner type to string");
                 p.setAdditionalProperties(inner);
             }
-            return getSchemaType(target) + "<String, " + getTypeDeclaration(inner) + ">";
+            typeDeclaration = getSchemaType(target) + "<String, " + getTypeDeclaration(inner, true) + ">";
+        } else {
+            typeDeclaration = super.getTypeDeclaration(p);
         }
-        return super.getTypeDeclaration(p);
+
+        if (includeNullableSuffix && ModelUtils.isNullable(schema)) {
+            return typeDeclaration + "?";
+        }
+
+        return typeDeclaration;
     }
 
     @Override

modules/openapi-generator/src/main/resources/dart2/serialization/native/native_class.mustache

@@ -142,10 +142,10 @@ class {{{classname}}} {
         {{{name}}}: json[r'{{{baseName}}}'] is List
           ? (json[r'{{{baseName}}}'] as List).map((e) =>
               {{#items.complexType}}
-              {{items.complexType}}.listFromJson(json[r'{{{baseName}}}']){{#uniqueItems}}.toSet(){{/uniqueItems}}
+              {{items.complexType}}.listFromJson(e){{#uniqueItems}}.toSet(){{/uniqueItems}}
               {{/items.complexType}}
               {{^items.complexType}}
-              e == null ? {{#items.isNullable}}null{{/items.isNullable}}{{^items.isNullable}}const  <{{items.items.dataType}}>[]{{/items.isNullable}} : (e as List).cast<{{items.items.dataType}}>()
+              e == null ? {{#items.isNullable}}null{{/items.isNullable}}{{^items.isNullable}}const <{{items.items.dataType}}{{#items.items.isNullable}}?{{/items.items.isNullable}}>[]{{/items.isNullable}} : (e as List).map((value) => value as {{items.items.dataType}}{{#items.items.isNullable}}?{{/items.items.isNullable}}).toList(growable: false)
               {{/items.complexType}}
             ).toList()
           :  {{#isNullable}}null{{/isNullable}}{{^isNullable}}const []{{/isNullable}},
@@ -163,7 +163,7 @@ class {{{classname}}} {
             : {{items.complexType}}.mapListFromJson(json[r'{{{baseName}}}']),
                 {{/items.complexType}}
                 {{^items.complexType}}
-            : (json[r'{{{baseName}}}'] as Map<String, dynamic>).map((k, v) => MapEntry(k, v == null ? {{#items.isNullable}}null{{/items.isNullable}}{{^items.isNullable}}const <{{items.items.dataType}}>[]{{/items.isNullable}} : (v as List).cast<{{items.items.dataType}}>())),
+            : (json[r'{{{baseName}}}'] as Map<String, dynamic>).map((k, v) => MapEntry(k, v == null ? {{#items.isNullable}}null{{/items.isNullable}}{{^items.isNullable}}const <{{items.items.dataType}}{{#items.items.isNullable}}?{{/items.items.isNullable}}>[]{{/items.isNullable}} : (v as List).map((value) => value as {{items.items.dataType}}{{#items.items.isNullable}}?{{/items.items.isNullable}}).toList(growable: false))),
                 {{/items.complexType}}
               {{/items.isArray}}
               {{^items.isArray}}

modules/openapi-generator/src/test/java/org/openapitools/codegen/dart/DartModelTest.java

@@ -564,4 +564,28 @@ public void dateTest() {
         Assert.assertEquals(op.returnType, "DateTime");
         Assert.assertEquals(op.bodyParam.dataType, "DateTime");
     }
+
+    @Test(description = "array items can be nullable")
+    public void arrayItemsCanBeNullable() {
+        final OpenAPI openAPI = TestUtils.parseFlattenSpec("src/test/resources/3_0/array-nullable-items.yaml");
+        final DefaultCodegen codegen = new DartClientCodegen();
+        codegen.setOpenAPI(openAPI);
+        final ArraySchema schema = (ArraySchema) openAPI.getComponents().getSchemas().get("ArrayWithNullableItemsModel")
+                .getProperties()
+                .get("foo");
+
+        Assert.assertEquals(codegen.getTypeDeclaration(schema), "List<String?>");
+    }
+
+    @Test(description = "nested array items can be nullable")
+    public void nestedArrayItemsCanBeNullable() {
+        final OpenAPI openAPI = TestUtils.parseFlattenSpec("src/test/resources/3_0/nested-array-nullable-items.yaml");
+        final DefaultCodegen codegen = new DartClientCodegen();
+        codegen.setOpenAPI(openAPI);
+        final ArraySchema schema = (ArraySchema) openAPI.getComponents().getSchemas().get("NestedArrayWithNullableItemsModel")
+                .getProperties()
+                .get("foo");
+
+        Assert.assertEquals(codegen.getTypeDeclaration(schema), "List<List<String?>>");
+    }
 }

modules/openapi-generator/src/test/java/org/openapitools/codegen/dart/dio/DartDioModelTest.java

@@ -492,4 +492,32 @@ public void dateDefaultValues() {
         Assert.assertEquals(dateTimeDefault.name, "dateTime");
         Assert.assertNull(dateTimeDefault.defaultValue);
     }
+
+    @Test(description = "array items can be nullable")
+    public void arrayItemsCanBeNullable() {
+        final OpenAPI openAPI = TestUtils.parseFlattenSpec("src/test/resources/3_0/array-nullable-items.yaml");
+        final DartDioClientCodegen codegen = new DartDioClientCodegen();
+        codegen.additionalProperties().put(CodegenConstants.SERIALIZATION_LIBRARY, DartDioClientCodegen.SERIALIZATION_LIBRARY_BUILT_VALUE);
+        codegen.processOpts();
+        codegen.setOpenAPI(openAPI);
+        final ArraySchema schema = (ArraySchema) openAPI.getComponents().getSchemas().get("ArrayWithNullableItemsModel")
+                .getProperties()
+                .get("foo");
+
+        Assert.assertEquals(codegen.getTypeDeclaration(schema), "BuiltList<String?>");
+    }
+
+    @Test(description = "nested array items can be nullable")
+    public void nestedArrayItemsCanBeNullable() {
+        final OpenAPI openAPI = TestUtils.parseFlattenSpec("src/test/resources/3_0/nested-array-nullable-items.yaml");
+        final DartDioClientCodegen codegen = new DartDioClientCodegen();
+        codegen.additionalProperties().put(CodegenConstants.SERIALIZATION_LIBRARY, DartDioClientCodegen.SERIALIZATION_LIBRARY_BUILT_VALUE);
+        codegen.processOpts();
+        codegen.setOpenAPI(openAPI);
+        final ArraySchema schema = (ArraySchema) openAPI.getComponents().getSchemas().get("NestedArrayWithNullableItemsModel")
+                .getProperties()
+                .get("foo");
+
+        Assert.assertEquals(codegen.getTypeDeclaration(schema), "BuiltList<BuiltList<String?>>");
+    }
 }

modules/openapi-generator/src/test/resources/3_0/nested-array-nullable-items.yaml

@@ -0,0 +1,28 @@
+openapi: 3.0.0
+info:
+  title: Nested array nullable items
+  version: latest
+paths:
+  '/':
+    get:
+      operationId: operation
+      responses:
+        '200':
+          description: Success
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/NestedArrayWithNullableItemsModel'
+components:
+  schemas:
+    NestedArrayWithNullableItemsModel:
+      required:
+        - foo
+      properties:
+        foo:
+          type: array
+          items:
+            type: array
+            items:
+              type: string
+              nullable: true

samples/openapi3/client/petstore/dart-dio/petstore_client_lib_fake-json_serializable/doc/NullableClass.md

@@ -15,11 +15,11 @@ Name | Type | Description | Notes
 **dateProp** | [**DateTime**](DateTime.md) |  | [optional] 
 **datetimeProp** | [**DateTime**](DateTime.md) |  | [optional] 
 **arrayNullableProp** | **List<Object>** |  | [optional] 
-**arrayAndItemsNullableProp** | **List<Object>** |  | [optional] 
-**arrayItemsNullable** | **List<Object>** |  | [optional] 
+**arrayAndItemsNullableProp** | **List<Object?>** |  | [optional] 
+**arrayItemsNullable** | **List<Object?>** |  | [optional] 
 **objectNullableProp** | **Map<String, Object>** |  | [optional] 
-**objectAndItemsNullableProp** | **Map<String, Object>** |  | [optional] 
-**objectItemsNullable** | **Map<String, Object>** |  | [optional] 
+**objectAndItemsNullableProp** | **Map<String, Object?>** |  | [optional] 
+**objectItemsNullable** | **Map<String, Object?>** |  | [optional] 
 
 [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
 

samples/openapi3/client/petstore/dart-dio/petstore_client_lib_fake-json_serializable/lib/src/model/nullable_class.dart

@@ -137,7 +137,7 @@ class NullableClass {
   )
 
 
-  final List<Object>? arrayAndItemsNullableProp;
+  final List<Object?>? arrayAndItemsNullableProp;
 
 
 
@@ -149,7 +149,7 @@ class NullableClass {
   )
 
 
-  final List<Object>? arrayItemsNullable;
+  final List<Object?>? arrayItemsNullable;
 
 
 
@@ -173,7 +173,7 @@ class NullableClass {
   )
 
 
-  final Map<String, Object>? objectAndItemsNullableProp;
+  final Map<String, Object?>? objectAndItemsNullableProp;
 
 
 
@@ -185,7 +185,7 @@ class NullableClass {
   )
 
 
-  final Map<String, Object>? objectItemsNullable;
+  final Map<String, Object?>? objectItemsNullable;
 
 
 

samples/openapi3/client/petstore/dart-dio/petstore_client_lib_fake/doc/NullableClass.md

@@ -15,11 +15,11 @@ Name | Type | Description | Notes
 **dateProp** | [**Date**](Date.md) |  | [optional] 
 **datetimeProp** | [**DateTime**](DateTime.md) |  | [optional] 
 **arrayNullableProp** | [**BuiltList<JsonObject>**](JsonObject.md) |  | [optional] 
-**arrayAndItemsNullableProp** | [**BuiltList<JsonObject>**](JsonObject.md) |  | [optional] 
-**arrayItemsNullable** | [**BuiltList<JsonObject>**](JsonObject.md) |  | [optional] 
+**arrayAndItemsNullableProp** | [**BuiltList<JsonObject?>**](JsonObject.md) |  | [optional] 
+**arrayItemsNullable** | [**BuiltList<JsonObject?>**](JsonObject.md) |  | [optional] 
 **objectNullableProp** | [**BuiltMap<String, JsonObject>**](JsonObject.md) |  | [optional] 
-**objectAndItemsNullableProp** | [**BuiltMap<String, JsonObject>**](JsonObject.md) |  | [optional] 
-**objectItemsNullable** | [**BuiltMap<String, JsonObject>**](JsonObject.md) |  | [optional] 
+**objectAndItemsNullableProp** | [**BuiltMap<String, JsonObject?>**](JsonObject.md) |  | [optional] 
+**objectItemsNullable** | [**BuiltMap<String, JsonObject?>**](JsonObject.md) |  | [optional] 
 
 [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
 

samples/openapi3/client/petstore/dart2/petstore_client_lib_fake/doc/NullableClass.md

@@ -15,11 +15,11 @@ Name | Type | Description | Notes
 **dateProp** | [**DateTime**](DateTime.md) |  | [optional] 
 **datetimeProp** | [**DateTime**](DateTime.md) |  | [optional] 
 **arrayNullableProp** | [**List<Object>**](Object.md) |  | [optional] [default to const []]
-**arrayAndItemsNullableProp** | [**List<Object>**](Object.md) |  | [optional] [default to const []]
-**arrayItemsNullable** | [**List<Object>**](Object.md) |  | [optional] [default to const []]
+**arrayAndItemsNullableProp** | [**List<Object?>**](Object.md) |  | [optional] [default to const []]
+**arrayItemsNullable** | [**List<Object?>**](Object.md) |  | [optional] [default to const []]
 **objectNullableProp** | [**Map<String, Object>**](Object.md) |  | [optional] [default to const {}]
-**objectAndItemsNullableProp** | [**Map<String, Object>**](Object.md) |  | [optional] [default to const {}]
-**objectItemsNullable** | [**Map<String, Object>**](Object.md) |  | [optional] [default to const {}]
+**objectAndItemsNullableProp** | [**Map<String, Object?>**](Object.md) |  | [optional] [default to const {}]
+**objectItemsNullable** | [**Map<String, Object?>**](Object.md) |  | [optional] [default to const {}]
 
 [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
 

samples/openapi3/client/petstore/dart2/petstore_client_lib_fake/lib/model/additional_properties_class.dart

@@ -71,7 +71,7 @@ class AdditionalPropertiesClass {
         mapOfMapProperty: mapCastOfType<String, dynamic>(json, r'map_of_map_property') ?? const {},
         mapOfArrayInteger: json[r'map_of_array_integer'] == null
           ? const {}
-            : (json[r'map_of_array_integer'] as Map<String, dynamic>).map((k, v) => MapEntry(k, v == null ? const <int>[] : (v as List).cast<int>())),
+            : (json[r'map_of_array_integer'] as Map<String, dynamic>).map((k, v) => MapEntry(k, v == null ? const <int>[] : (v as List).map((value) => value as int).toList(growable: false))),
       );
     }
     return null;