[dart-dio] Fix json_serializable response for type:string format:binary (#21379)

* fixed inconsistencies with the dart-dio json_serializable string binary response types

* update deserialize template to handle responseFile

* regenerate samples

* only convert return_type to Uint8List

* remove unused imports from previous changes

* fixed issues where import wouldn't get included

* specific unit test for binary response

* reverted changes to nested generators

* removed 2 additional php modifications

* regen samples

Author: matthewnitschke-wk

bin/configs/dart-dio-binary-response.yaml

@@ -0,0 +1,8 @@
+generatorName: dart-dio
+outputDir: samples/openapi3/client/petstore/dart-dio/binary_response
+inputSpec: modules/openapi-generator/src/test/resources/3_0/issue_20682.yaml
+templateDir: modules/openapi-generator/src/main/resources/dart/libraries/dio
+additionalProperties:
+  hideGenerationTimestamp: "true"
+  enumUnknownDefaultCase: "true"
+  serializationLibrary: "json_serializable"

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

@@ -670,6 +670,17 @@ public OperationsMap postProcessOperationsWithModels(OperationsMap objs, List<Mo
                 op.imports.remove("Uint8List");
             }
 
+            if (SERIALIZATION_LIBRARY_JSON_SERIALIZABLE.equals(library)) {
+                // built_value serialization uses Uint8List for all MultipartFile types
+                // in json_serialization, MultipartFile is used as the file parameter type, but
+                // MultipartFile isn't readable, instead we convert this to a Uin8List
+                if (op.isResponseFile) {
+                    op.imports.add("Uint8List");
+                    op.returnType = "Uint8List";
+                    op.returnBaseType = "Uint8List";
+                }
+            }
+
             resultImports.addAll(rewriteImports(op.imports, false));
 
             if (SERIALIZATION_LIBRARY_BUILT_VALUE.equals(library)) {

modules/openapi-generator/src/main/resources/dart/libraries/dio/serialization/json_serializable/api/deserialize.mustache

@@ -1,2 +1,7 @@
 final rawData = _response.data;
-_responseData = rawData == null ? null : deserialize<{{{returnType}}}, {{{returnBaseType}}}>(rawData, '{{{returnType}}}', growable: true);
+{{#isResponseFile}}
+_responseData = rawData == null ? null : rawData as {{{returnType}}};
+{{/isResponseFile}}
+{{^isResponseFile}}
+_responseData = rawData == null ? null : deserialize<{{{returnType}}}, {{{returnBaseType}}}>(rawData, '{{{returnType}}}', growable: true);
+{{/isResponseFile}}

modules/openapi-generator/src/test/resources/3_0/issue_20682.yaml

@@ -0,0 +1,16 @@
+openapi: 3.0.0
+info:
+  version: 1.0.0
+  title: Binary response
+paths:
+  /limits:
+    get:
+      operationId: binaryResponse
+      responses:
+        '200':
+          description: OK
+          content:
+            application/zip:
+              schema:
+                type: string
+                format: binary

samples/openapi3/client/petstore/dart-dio/binary_response/.gitignore

@@ -0,0 +1,41 @@
+# See https://dart.dev/guides/libraries/private-files
+
+# Files and directories created by pub
+.dart_tool/
+.buildlog
+.packages
+.project
+.pub/
+build/
+**/packages/
+
+# Files created by dart2js
+# (Most Dart developers will use pub build to compile Dart, use/modify these
+#  rules if you intend to use dart2js directly
+#  Convention is to use extension '.dart.js' for Dart compiled to Javascript to
+#  differentiate from explicit Javascript files)
+*.dart.js
+*.part.js
+*.js.deps
+*.js.map
+*.info.json
+
+# Directory created by dartdoc
+doc/api/
+
+# Don't commit pubspec lock file
+# (Library packages only! Remove pattern if developing an application package)
+pubspec.lock
+
+# Don’t commit files and directories created by other development environments.
+# For example, if your development environment creates any of the following files,
+# consider putting them in a global ignore file:
+
+# IntelliJ
+*.iml
+*.ipr
+*.iws
+.idea/
+
+# Mac
+.DS_Store

samples/openapi3/client/petstore/dart-dio/binary_response/.openapi-generator-ignore

@@ -0,0 +1,23 @@
+# OpenAPI Generator Ignore
+# Generated by openapi-generator https://github.com/openapitools/openapi-generator
+
+# Use this file to prevent files from being overwritten by the generator.
+# The patterns follow closely to .gitignore or .dockerignore.
+
+# As an example, the C# client generator defines ApiClient.cs.
+# You can make changes and tell OpenAPI Generator to ignore just this file by uncommenting the following line:
+#ApiClient.cs
+
+# You can match any string of characters against a directory, file or extension with a single asterisk (*):
+#foo/*/qux
+# The above matches foo/bar/qux and foo/baz/qux, but not foo/bar/baz/qux
+
+# You can recursively match patterns against a directory, file or extension with a double asterisk (**):
+#foo/**/qux
+# This matches foo/bar/qux, foo/baz/qux, and foo/bar/baz/qux
+
+# You can also negate patterns with an exclamation (!).
+# For example, you can ignore all files in a docs folder with the file extension .md:
+#docs/*.md
+# Then explicitly reverse the ignore rule for a single file:
+#!docs/README.md

samples/openapi3/client/petstore/dart-dio/binary_response/.openapi-generator/FILES

@@ -0,0 +1,15 @@
+.gitignore
+README.md
+analysis_options.yaml
+build.yaml
+doc/DefaultApi.md
+lib/openapi.dart
+lib/src/api.dart
+lib/src/api/default_api.dart
+lib/src/auth/api_key_auth.dart
+lib/src/auth/auth.dart
+lib/src/auth/basic_auth.dart
+lib/src/auth/bearer_auth.dart
+lib/src/auth/oauth.dart
+lib/src/deserialize.dart
+pubspec.yaml

samples/openapi3/client/petstore/dart-dio/binary_response/.openapi-generator/VERSION

@@ -0,0 +1 @@
+7.14.0-SNAPSHOT

samples/openapi3/client/petstore/dart-dio/binary_response/README.md

@@ -0,0 +1,83 @@
+# openapi (EXPERIMENTAL)
+No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+
+This Dart package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
+
+- API version: 1.0.0
+- Generator version: 7.14.0-SNAPSHOT
+- Build package: org.openapitools.codegen.languages.DartDioClientCodegen
+
+## Requirements
+
+* Dart 2.15.0+ or Flutter 2.8.0+
+* Dio 5.0.0+ (https://pub.dev/packages/dio)
+* JSON Serializable 6.1.5+ (https://pub.dev/packages/json_serializable)
+
+## Installation & Usage
+
+### pub.dev
+To use the package from [pub.dev](https://pub.dev), please include the following in pubspec.yaml
+```yaml
+dependencies:
+  openapi: 1.0.0
+```
+
+### Github
+If this Dart package is published to Github, please include the following in pubspec.yaml
+```yaml
+dependencies:
+  openapi:
+    git:
+      url: https://github.com/GIT_USER_ID/GIT_REPO_ID.git
+      #ref: main
+```
+
+### Local development
+To use the package from your local drive, please include the following in pubspec.yaml
+```yaml
+dependencies:
+  openapi:
+    path: /path/to/openapi
+```
+
+## Getting Started
+
+Please follow the [installation procedure](#installation--usage) and then run the following:
+
+```dart
+import 'package:openapi/openapi.dart';
+
+
+final api = Openapi().getDefaultApi();
+
+try {
+    final response = await api.binaryResponse();
+    print(response);
+} catch on DioException (e) {
+    print("Exception when calling DefaultApi->binaryResponse: $e\n");
+}
+
+```
+
+## Documentation for API Endpoints
+
+All URIs are relative to *http://localhost*
+
+Class | Method | HTTP request | Description
+------------ | ------------- | ------------- | -------------
+[*DefaultApi*](doc/DefaultApi.md) | [**binaryResponse**](doc/DefaultApi.md#binaryresponse) | **GET** /limits | 
+
+
+## Documentation For Models
+
+
+
+## Documentation For Authorization
+
+Endpoints do not require authorization.
+
+
+## Author
+
+
+

samples/openapi3/client/petstore/dart-dio/binary_response/analysis_options.yaml

@@ -0,0 +1,10 @@
+analyzer:
+  language:
+    strict-inference: true
+    strict-raw-types: true
+    strict-casts: false
+  exclude:
+    - test/*.dart
+    - lib/src/model/*.g.dart
+  errors:
+    deprecated_member_use_from_same_package: ignore