retrofit

fix(generator): detect generated and abstract toJson on Freezed models (

#927)

lookUpMethod misses toJson when the Freezed part file is hidden from
retrofit_generator. Treat a source fromJson factory as evidence that
json_serializable generated toJson, and still look up mixin/abstract
methods when they are visible.

Fixes #914

What's Changed

• Add dart_mappable parser support for type conversion by @Copilot in #847
• Fix toJson detection for Freezed models using lookUpMethod2 by @Copilot in #860
• Enhance error handling documentation in README by @farmery in #864
• Support analyzer '>=8.0.0 <10.0.0' and update deprecated methods by @Carapacik in #863
• Make Response parameter in ParseErrorLogger optional for backward compatibility by @Copilot in #865
• Add format_output option to control dart format comments in generated code by @Copilot in #861
• Update protobuf to 6.0.0 and update protobuf example by @Carapacik in #866
• fix: added code generation logic for multipart datetime by @kryptonpust in #874
• Fix streaming response handling and add SSE support by @westito in #881

New Contributors

• @kryptonpust made their first contribution in #874

Full Changelog: retrofit-v4.9.1...retrofit-v4.9.2

• Add DartMappable parser support for dart_mappable package integration

• Make Response parameter in ParseErrorLogger callback optional for backward compatibility
  • The response parameter in logError is now a named optional parameter {Response? response}
  • This allows existing implementations without the response parameter to continue working

• Version bump to 4.9.0

• Add global headers support to @RestApi annotation
• This version is required for retrofit_generator 10.1.0+

• Add comments for each public methods
• Enable linter rules for public api docs

• update to new tag format with prefix letter v

• Updates minimum supported SDK version to Dart 3.8.

• Added @BodyExtra annotation to support adding individual fields to request body, enhancing flexibility and extensibility.

  Example :

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

  The request body will be：

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

• 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<User> getTasks();
  }

• 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);
  

• Required Dart 2.19
• Update README

• 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);
  

• Update dio to ^5.0.0

• remove autoCastResponse annotation

• add recommended dart lints to project

• add multipart mime type (#437)

• fix pub warning

• add compute support

• rollback to dio
• update dio to 4.0.1

• add CacheControl

• Nullsafety support

• Add dart json mapper deserialize support

• [BREAKING CHANGE] Change Part's params to named parameters from optional ones.

• Add contentType to Part annotation

• Add custom options support to each request
• fix #132

• Bumped retrofit's SDK requirement to >=2.6.0

• Add HttpReponse to handle original response

• [BREAKING CHANGE] Add new Part annotation to send multipart/form-data request. Field will not be used in the future, please use Part instead.

• Add dio response type support

• Support dio 3.0

• Added autoCastResponse option to RestApi and all Method annotations (default : true)

• Added auto_cast_response to builder options.

  • Users can specify this in build.yaml as global default

    targets:
      $default:
        sources: ["lib/**"]
        builders:
          retrofit_generator|retrofit:
            enabled: true
            options:
              auto_cast_response: true
    

• fix: fix bad cast exception (#47)
• add CancelToken, SendProgress, and ReceiveProgress (#46)

• [BREAKING CHANGE] only works dart 2.2.2 and above
• Added support to multiple clients with different base urls.

• Fixed analysis report use retrofit.dart instead of http.dart and dio.dart to import classes

• Updated docs and sample code

• Added optional parameter fileName in @Field annotation for custom file name

• add example

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

  Example :

  @http.POST('/path/')
  @dio.Extra({'my_key':'my_value'})
  Future<String> myMethod();
  

• Fixed general dart style and code conventions

• Automatically null check with ArgumentError.checkNotNull for required parameters

• Now SuperClasses can use forwarding/redirecting constructors instead of static instance() method

  Example :

  @RestApi(baseUrl: "https://httpbin.org/")
  abstract class RestClient {
      /// Forwarding constructor
      factory RestClient([Dio dio]) = _RestClient;
  }