Export MediaType from http_parser (#2205)

Resolves #2212 ### Additional context and info (if any) Exports `DioMediaType` as the alias of `MediaType` from the `http_parser` package so users don't have to import the transitive dependency explicitly. --------- Signed-off-by: Benjamin <[email protected]> Co-authored-by: Alex Li <[email protected]>
cfug · May 22, 2024 · f87a095 · f87a095
1 parent 0eab30a
commit f87a095
Show file tree

Hide file tree

Showing 5 changed files with 17 additions and 16 deletions.
diff --git a/dio/CHANGELOG.md b/dio/CHANGELOG.md
@@ -7,6 +7,7 @@ See the [Migration Guide][] for the complete breaking changes list.**
 
 - Raise the min Dart SDK version to 2.18.0.
 - Add constructor for `DioExceptionType.badCertificate`.
+- Create type alias `DioMediaType` for `http_parser`'s `MediaType`.
 
 ## 5.4.3+1
 

diff --git a/dio/lib/src/multipart_file.dart b/dio/lib/src/multipart_file.dart
@@ -7,6 +7,9 @@ import 'multipart_file/io_multipart_file.dart'
     if (dart.library.html) 'multipart_file/browser_multipart_file.dart';
 import 'utils.dart';
 
+/// The type (alias) for specifying the content-type of the `MultipartFile`.
+typedef DioMediaType = MediaType;
+
 /// A file to be uploaded as part of a [MultipartRequest]. This doesn't need to
 /// correspond to a physical file.
 ///
@@ -27,7 +30,7 @@ class MultipartFile {
     Stream<List<int>> stream,
     this.length, {
     this.filename,
-    MediaType? contentType,
+    DioMediaType? contentType,
     Map<String, List<String>>? headers,
   })  : _data = (() => stream),
         headers = caseInsensitiveKeyMap(headers),
@@ -43,7 +46,7 @@ class MultipartFile {
     Stream<List<int>> Function() data,
     this.length, {
     this.filename,
-    MediaType? contentType,
+    DioMediaType? contentType,
     Map<String, List<String>>? headers,
   })  : _data = data,
         headers = caseInsensitiveKeyMap(headers),
@@ -56,7 +59,7 @@ class MultipartFile {
   factory MultipartFile.fromBytes(
     List<int> value, {
     String? filename,
-    MediaType? contentType,
+    DioMediaType? contentType,
     final Map<String, List<String>>? headers,
   }) {
     return MultipartFile.fromStream(
@@ -77,7 +80,7 @@ class MultipartFile {
   factory MultipartFile.fromString(
     String value, {
     String? filename,
-    MediaType? contentType,
+    DioMediaType? contentType,
     final Map<String, List<String>>? headers,
   }) {
     contentType ??= MediaType('text', 'plain');
@@ -106,7 +109,7 @@ class MultipartFile {
   final Map<String, List<String>>? headers;
 
   /// The content-type of the file. Defaults to `application/octet-stream`.
-  final MediaType? contentType;
+  final DioMediaType? contentType;
 
   /// The stream builder that will emit the file's contents for every call.
   final Stream<List<int>> Function() _data;
@@ -125,7 +128,7 @@ class MultipartFile {
   static Future<MultipartFile> fromFile(
     String filePath, {
     String? filename,
-    MediaType? contentType,
+    DioMediaType? contentType,
     final Map<String, List<String>>? headers,
   }) =>
       multipartFileFromPath(
@@ -138,7 +141,7 @@ class MultipartFile {
   static MultipartFile fromFileSync(
     String filePath, {
     String? filename,
-    MediaType? contentType,
+    DioMediaType? contentType,
     final Map<String, List<String>>? headers,
   }) =>
       multipartFileFromPathSync(

diff --git a/dio/lib/src/multipart_file/io_multipart_file.dart b/dio/lib/src/multipart_file/io_multipart_file.dart
@@ -1,15 +1,14 @@
 import 'dart:async';
 import 'dart:io';
 
-import 'package:http_parser/http_parser.dart';
 import 'package:path/path.dart' as p;
 
 import '../multipart_file.dart';
 
 Future<MultipartFile> multipartFileFromPath(
   String filePath, {
   String? filename,
-  MediaType? contentType,
+  DioMediaType? contentType,
   final Map<String, List<String>>? headers,
 }) async {
   filename ??= p.basename(filePath);
@@ -27,7 +26,7 @@ Future<MultipartFile> multipartFileFromPath(
 MultipartFile multipartFileFromPathSync(
   String filePath, {
   String? filename,
-  MediaType? contentType,
+  DioMediaType? contentType,
   final Map<String, List<String>>? headers,
 }) {
   filename ??= p.basename(filePath);

diff --git a/dio/test/formdata_test.dart b/dio/test/formdata_test.dart
@@ -2,7 +2,6 @@ import 'dart:convert';
 import 'dart:io';
 
 import 'package:dio/dio.dart';
-import 'package:http_parser/http_parser.dart';
 import 'package:test/test.dart';
 
 import 'mock/adapters.dart';
@@ -36,7 +35,7 @@ void main() async {
               headers: {
                 'test': <String>['c'],
               },
-              contentType: MediaType.parse('text/plain'),
+              contentType: DioMediaType.parse('text/plain'),
             ),
           ],
         });
@@ -88,7 +87,7 @@ void main() async {
               headers: {
                 'test': <String>['c'],
               },
-              contentType: MediaType.parse('text/plain'),
+              contentType: DioMediaType.parse('text/plain'),
             ),
           ),
         );
@@ -124,7 +123,7 @@ void main() async {
               headers: {
                 'test': <String>['c'],
               },
-              contentType: MediaType.parse('text/plain'),
+              contentType: DioMediaType.parse('text/plain'),
             ),
           ],
         });

diff --git a/dio/test/multipart_file_test.dart b/dio/test/multipart_file_test.dart
@@ -1,13 +1,12 @@
 import 'package:dio/dio.dart';
-import 'package:http_parser/http_parser.dart';
 import 'package:test/test.dart';
 
 void main() async {
   group(MultipartFile, () {
     test(
       'fromFile sets correct content-type',
       () async {
-        final mediaType = MediaType.parse('text/plain');
+        final mediaType = DioMediaType.parse('text/plain');
         final file = await MultipartFile.fromFile(
           'test/mock/_testfile',
           filename: '1.txt',