retrofit_generator

fix(generator): use utf8.decoder.bind for string streams to prevent m…

…alformed chunk exceptions (#931)

fix: keep the request future in the stream pipeline for ResponseType.…

…stream (#921)

Closes #907. Generated methods for @DioResponseType(ResponseType.stream) awaited
the request future inside an async* body, so if the subscription was cancelled
while suspended at the await, a later error from that future could escape the
stream listener lifecycle and surface as an unhandled zone error. Emit
_dio.fetch<ResponseBody>(...) without await and expand it through
asStream().asyncExpand(...) instead, keeping the future inside the stream.

Fix map value deserialization for generic type-parameter models in ge…

…nerator output (#916)

* Initial plan

* fix(generator): handle type parameters in map generic value deserialization

Agent-Logs-Url: https://github.com/trevorwang/retrofit.dart/sessions/e48c0b86-23bc-473a-89ba-a5a699fabd2a

Co-authored-by: trevorwang <[email protected]>

---------

Co-authored-by: copilot-swe-agent[bot] <[email protected]>
Co-authored-by: trevorwang <[email protected]>

What's Changed

• chore: add avoid_redundant_argument_values to analyzer ignores by @gktirkha in #913
• Allow analyzer 13.0.0 by @Carapacik in #912
• Use toString() for multipart enum values by @kyungilcho in #896

New Contributors

• @gktirkha made their first contribution in #913
• @kyungilcho made their first contribution in #896

Full Changelog: v10.2.5...v10.2.6

• Allow analyzer 13.0.0.

What's Changed

• Allow new analyzer and temp delete lean_builder form dependencies by @Carapacik in #897
• build(deps-dev): bump js-yaml from 4.1.0 to 4.1.1 by @dependabot[bot] in #853
• build(deps-dev): bump lodash from 4.17.21 to 4.17.23 by @dependabot[bot] in #888
• Release retrofit 4.9.1: Fix ParseErrorLogger signature for backward compatibility by @Copilot in #883
• Fix: add warning for missing dart:convert import when using ResponseType.stream by @japanshah17 in #905

New Contributors

• @japanshah17 made their first contribution in #905

Full Changelog: v10.2.3...v10.2.4

• Allow analyzer 12.0.0.

Document analyzer 9.x compatibility fix in CHANGELOG (#875)

* Initial plan

* Update CHANGELOG to document analyzer 9.0.0 compatibility fix

Co-authored-by: trevorwang <[email protected]>

* Clarify analyzer 9.x compatibility in CHANGELOG (supports all 9.x versions)

Co-authored-by: trevorwang <[email protected]>

---------

Co-authored-by: copilot-swe-agent[bot] <[email protected]>
Co-authored-by: trevorwang <[email protected]>
Co-authored-by: Trevor Wang <[email protected]>

• Allow analyzer 10.0.0

• Fix analyzer 9.x compatibility: Remove deprecated Element2 API usage that caused build failures with analyzer 9.0+
• Support analyzer '>=8.0.0 <10.0.0' (supports all 8.x and 9.x versions)
• Migrate from deprecated analyzer Element2 APIs to stable Element APIs

• Extend analyzer dependency range to support analyzer 9.0.0 ('>=7.7.1 <10.0.0')
• Note: Full analyzer 9.0.0 API migration is pending. For now, the package declares compatibility but may require dependency_overrides to resolve to analyzer 8.x until all dependencies are updated
• Add Response parameter to logError response data parsing callback
• Add format_output builder option to control generation of // dart format off/on comments (default: true)
  • Set format_output: false in build.yaml to omit format suppressing comments
  • This allows combining retrofit with other generators (like riverpod) in a more predictable way

• Add lean_builder as a dependency to support experimental lean_builder integration
• Fix package validation errors for lean_builder imports
• Prepare infrastructure for optional lean_builder support

• Update protobuf to 5.0.0

• Allow build 4.0.0.

• Format generated code with default DartFormatter
• Add dart format off and dart format on comments to generated code

• Fix dependencies versions

• Migrate to Element2
• Updates minimum supported SDK version to Dart 3.8

• Upgrade build_runner to 2.5.4

• Updates minimum supported SDK version to Dart 3.6

• Added @BodyExtra annotation: Add individual fields to request body without defining complete DTO classes

  • Support for adding dynamic fields to existing request bodies
  • expand parameter (default: false) to control object field flattening behavior

  Example(Combine fields):

  @http.POST('/path/')
  Future<String> updateValue(@BodyExtra('id') int id, @BodyExtra('value') String value);
  

  Request body result:

  {"id": 123, "value": "some value"}
  

  Example(Combine objects):

  // pseudocode
  class User {
    int userId;
    String userName;
  }
  
  class Settings {
    int a;
    int b;
  }
  
  @http.POST('/path/')
  Future<String> updateValue(
    @BodyExtra('user', expand: true) User user, 
    @BodyExtra('settings', expand: true) Settings settings,
  );
  

  Request body result:

  {"userId": 123, "userName": "hhh", "a": 1, "b": 2}
  

• Update protobuf version to 4.0.0

• Fixed issue with @Part annotation with toJson() enum values.

  Example:

  import 'package:json_annotation/json_annotation.dart';
  
  @JsonEnum()
  enum TestEnumWithToJson { 
    @JsonValue('A')
    A('A'), 
    @JsonValue('B')
    B('B'); 
  
    const TestEnumWithToJson(this.json);
    
    final String? json;
  
    String? toJson() => json;
  }
  
  @RestApi()
  abstract class TestModelList {
    @POST('/')
    Future<void> testEnumWithToJsonType(@Part() TestEnumWithToJson enumValue);
  }
  

• Fixed bug of callAdapter using yield/return incorrectly

• Fixed issue which generated invalid code for the same path parameter appears multiple times.

  Example:

  @GET('/image/{imageType}/{id}/{id}_XL.png')
  Future<HttpResponse<dynamic>> getImage(
    @Path('imageType') ImageType imageType,
    @Path('id') String id,
  );
  

• Introduced CallAdapters, This feature allows adaptation of a Call with return type R into the type of T. e.g. Future<User> to Future<Result<User>>

  Code Example:

  class MyCallAdapter<T> extends CallAdapter<Future<T>, Future<Either<ApiError, T>>> {
    @override
    Future<Either<ApiError, T>> adapt(Future<T> Function() call) async {
      try {
        final response = await call();
        return Either.right(response);
      }
      catch (e) {
        return Either.left(ApiError(e));
      }
    }
  }

  @RestApi()
  abstract class RestClient {
    factory RestClient(Dio dio, {String? baseUrl}) = _RestClient;

    @UseCallAdapter(MyCallAdapter)
    @GET('/')
    Future<Either<ApiError, User>> getTasks();
  }

• Update analyzer, dart_style and source_gen dependencies to allow upper versions

• Add support for nested object of non-primitive types in TypedExtras.

  Example :

  @RestApi()
  abstract class TypedExtrasTest {
    @DummyTypedExtras(
      id: '1234',
      config: Config(
        date: '24-10-2024',
        type: 'analytics',
        shouldReplace: true,
        subConfig: {'date': '24-11-2025'},
      ),
    )
    @GET('path')
    Future<void> list();
  }
  

• Add support for multiple TypedExtras.

  Example :

  @TypedExtrasSubClass(
    id: 'abcd',
    fileType: FileType.json,
    destinations: [Destination.remote]
  )
  @AnotherTypedExtrasSubClass(
    state: 'Ohio',
    destinations: [Destination.remote]
  )
  @http.POST('/path/')
  Future<String> myMethod();
  

• Support passing Enums into TypedExtras.

  Example :

  @TypedExtrasSubClass(
    id: 'abcd',
    fileType: FileType.json,
    destinations: [Destination.remote]
  )
  @http.POST('/path/')
  Future<String> myMethod();
  

• Added @TypedExtras to pass extra options to dio requests using custom annotations.

  Example :

  @TypedExtrasSubClass(
    id: 'abcd',
    count: 5,
    shouldProceed: true,
  )
  @http.POST('/path/')
  Future<String> myMethod(@Extras() Map<String, dynamic> extras);
  

• Require Dart 3.3
• Fix issue with deprecated getDisplayString(withNullability: true)
• Update analyzer: ^6.5.0
• Update lints: ^4.0.0 and fix issues
• Remove tuple dependency

• Added @Extras to pass extra options to dio requests, response, transformer and interceptors.

  Example :

  @http.POST('/path/')
  Future<String> myMethod(@Extras() Map<String, dynamic> extras);
  

• @useResult

• fix #627 where generic argument constructors on any class not directly marked with @JsonSerializable(genericArgumentFactories: true)

• fix some typos in this changelog.

• fix #630 Null check operator used on a null value

• Add option class-name to customize the name of retrofit generator

• Add protobuf support
• Add PreventNullToAbsent annotation to allow null sent to server

• Use toJson() instead of .name if enums have toJson().

• Enums return types generated iterating over the enum values instead of calling .toJson() method
• Enums as query parameters generated with .name instead of toJson()

• Fix DateTime.toIso8601String() issue #586

• Add support for analyzer 6.0.0

• Fixed generation of DateTime used as @Query parameters (now it is converted to String using toIso8601String)

• Rename retrofit to retrofit_generator in build.yaml fix for build_runner ^2.4.4
• Add topics

• Fix deprecated warnings with analyzer 5.12.0
• [BREAKING CHANGE] Require Dart >= 2.19 for new analyzer

• [BREAKING CHANGE] Update min Dart sdk to 2.18
• Update example
• Fix link in readme