mapToQuery changes

chopper/lib/src/annotations.dart

@@ -161,11 +161,21 @@ class Method {
   /// Mark the body as optional to suppress warnings during code generation
   final bool optionalBody;
 
+  /// Use brackets [ ] to when encoding
+  ///
+  /// - lists
+  /// hxxp://path/to/script?foo[]=123&foo[]=456&foo[]=789
+  ///
+  /// - maps
+  /// hxxp://path/to/script?user[name]=john&user[surname]=doe&user[age]=21
+  final bool useBrackets;
+
   const Method(
     this.method, {
     this.optionalBody = false,
     this.path = '',
     this.headers = const {},
+    this.useBrackets = false,
   });
 }
 
@@ -176,6 +186,7 @@ class Get extends Method {
     super.optionalBody = true,
     super.path,
     super.headers,
+    super.useBrackets,
   }) : super(HttpMethod.Get);
 }
 
@@ -188,6 +199,7 @@ class Post extends Method {
     super.optionalBody,
     super.path,
     super.headers,
+    super.useBrackets,
   }) : super(HttpMethod.Post);
 }
 
@@ -198,6 +210,7 @@ class Delete extends Method {
     super.optionalBody = true,
     super.path,
     super.headers,
+    super.useBrackets,
   }) : super(HttpMethod.Delete);
 }
 
@@ -210,6 +223,7 @@ class Put extends Method {
     super.optionalBody,
     super.path,
     super.headers,
+    super.useBrackets,
   }) : super(HttpMethod.Put);
 }
 
@@ -221,6 +235,7 @@ class Patch extends Method {
     super.optionalBody,
     super.path,
     super.headers,
+    super.useBrackets,
   }) : super(HttpMethod.Patch);
 }
 
@@ -231,6 +246,7 @@ class Head extends Method {
     super.optionalBody = true,
     super.path,
     super.headers,
+    super.useBrackets,
   }) : super(HttpMethod.Head);
 }
 
@@ -240,6 +256,7 @@ class Options extends Method {
     super.optionalBody = true,
     super.path,
     super.headers,
+    super.useBrackets,
   }) : super(HttpMethod.Options);
 }
 

chopper/lib/src/request.dart

@@ -1,5 +1,4 @@
 import 'dart:async';
-import 'dart:convert';
 
 import 'package:http/http.dart' as http;
 import 'package:meta/meta.dart';
@@ -18,6 +17,7 @@ class Request {
   final Map<String, dynamic> parameters;
   final Map<String, String> headers;
   final bool multipart;
+  final bool useBrackets;
 
   const Request(
     this.method,
@@ -28,6 +28,7 @@ class Request {
     this.headers = const {},
     this.multipart = false,
     this.parts = const [],
+    this.useBrackets = false,
   });
 
   /// Makes a copy of this request, replacing original values with the given ones.
@@ -37,23 +38,25 @@ class Request {
     dynamic body,
     Map<String, dynamic>? parameters,
     Map<String, String>? headers,
-    Encoding? encoding,
     List<PartValue>? parts,
     bool? multipart,
     String? baseUrl,
+    bool? useBrackets,
   }) =>
       Request(
         (method ?? this.method) as String,
         url ?? this.url,
-        baseUrl ?? this.baseUrl,
         body: body ?? this.body,
         parameters: parameters ?? this.parameters,
         headers: headers ?? this.headers,
         parts: parts ?? this.parts,
         multipart: multipart ?? this.multipart,
+        baseUrl ?? this.baseUrl,
+        useBrackets: useBrackets ?? this.useBrackets,
       );
 
-  Uri _buildUri() => buildUri(baseUrl, url, parameters);
+  Uri _buildUri() =>
+      buildUri(baseUrl, url, parameters, useBrackets: useBrackets);
 
   Map<String, String> _buildHeaders() => {...headers};
 
@@ -110,7 +113,12 @@ class PartValueFile<T> extends PartValue<T> {
 /// Builds a valid URI from [baseUrl], [url] and [parameters].
 ///
 /// If [url] starts with 'http://' or 'https://', baseUrl is ignored.
-Uri buildUri(String baseUrl, String url, Map<String, dynamic> parameters) {
+Uri buildUri(
+  String baseUrl,
+  String url,
+  Map<String, dynamic> parameters, {
+  bool useBrackets = false,
+}) {
   // If the request's url is already a fully qualified URL, we can use it
   // as-is and ignore the baseUrl.
   Uri uri = url.startsWith('http://') || url.startsWith('https://')
@@ -119,7 +127,7 @@ Uri buildUri(String baseUrl, String url, Map<String, dynamic> parameters) {
           ? Uri.parse('$baseUrl/$url')
           : Uri.parse('$baseUrl$url');
 
-  String query = mapToQuery(parameters);
+  String query = mapToQuery(parameters, useBrackets: useBrackets);
   if (query.isNotEmpty) {
     if (uri.hasQuery) {
       query += '&${uri.query}';

chopper/lib/src/utils.dart

@@ -56,29 +56,39 @@ final chopperLogger = Logger('Chopper');
 /// Creates a valid URI query string from [map].
 ///
 /// E.g., `{'foo': 'bar', 'ints': [ 1337, 42 ] }` will become 'foo=bar&ints=1337&ints=42'.
-String mapToQuery(Map<String, dynamic> map) => _mapToQuery(map).join('&');
+String mapToQuery(Map<String, dynamic> map, {bool useBrackets = false}) =>
+    _mapToQuery(map, useBrackets: useBrackets).join('&');
 
 Iterable<_Pair<String, String>> _mapToQuery(
   Map<String, dynamic> map, {
   String? prefix,
+  bool useBrackets = false,
 }) {
   final Set<_Pair<String, String>> pairs = {};
 
   map.forEach((key, value) {
-    if (value != null) {
-      String name = Uri.encodeQueryComponent(key);
+    String name = Uri.encodeQueryComponent(key);
 
-      if (prefix != null) {
-        name = '$prefix.$name';
-      }
+    if (prefix != null) {
+      name = useBrackets
+          ? '$prefix${Uri.encodeQueryComponent('[')}$name${Uri.encodeQueryComponent(']')}'
+          : '$prefix.$name';
+    }
 
+    if (value != null) {
       if (value is Iterable) {
-        pairs.addAll(_iterableToQuery(name, value));
+        pairs.addAll(_iterableToQuery(name, value, useBrackets: useBrackets));
       } else if (value is Map<String, dynamic>) {
-        pairs.addAll(_mapToQuery(value, prefix: name));
-      } else if (value.toString().isNotEmpty) {
-        pairs.add(_Pair<String, String>(name, _normalizeValue(value)));
+        pairs.addAll(
+          _mapToQuery(value, prefix: name, useBrackets: useBrackets),
+        );
+      } else {
+        pairs.add(
+          _Pair<String, String>(name, _normalizeValue(value)),
+        );
       }
+    } else {
+      pairs.add(_Pair<String, String>(name, ''));
     }
   });
 
@@ -87,20 +97,34 @@ Iterable<_Pair<String, String>> _mapToQuery(
 
 Iterable<_Pair<String, String>> _iterableToQuery(
   String name,
-  Iterable values,
-) =>
-    values.map((v) => _Pair(name, _normalizeValue(v)));
+  Iterable values, {
+  bool useBrackets = false,
+}) =>
+    values.where((value) => value?.toString().isNotEmpty ?? false).map(
+          (value) => _Pair(
+            name,
+            _normalizeValue(value),
+            useBrackets: useBrackets,
+          ),
+        );
 
-String _normalizeValue(value) => Uri.encodeComponent(value.toString());
+String _normalizeValue(value) => Uri.encodeComponent(value?.toString() ?? '');
 
 class _Pair<A, B> {
   final A first;
   final B second;
+  final bool useBrackets;
 
-  const _Pair(this.first, this.second);
+  const _Pair(
+    this.first,
+    this.second, {
+    this.useBrackets = false,
+  });
 
   @override
-  String toString() => '$first=$second';
+  String toString() => useBrackets
+      ? '$first${Uri.encodeQueryComponent('[]')}=$second'
+      : '$first=$second';
 }
 
 bool isTypeOf<ThisType, OfType>() => _Instance<ThisType>() is _Instance<OfType>;