dart_mappable 4.2.1 copy "dart_mappable: ^4.2.1" to clipboard
dart_mappable: ^4.2.1 copied to clipboard

Improved json serialization and data classes with full support for generics, inheritance, customization and more.

4.2.1 #

  • Performance improvements.
  • Updated docs.

4.2.0 #

4.1.0 #

  • Added support for shallow encoding a class:
    • MyClassMapper.ensureInitialized().encodeMap<MyClass>(myClass, EncodingOptions(shallow: true))
  • Correctly escape $ in class names.
  • Added option to use unordered list equality with iterables:
    • IterableMapper.equalityMode = IterableEqualityMode.unordered
  • Added build_extensions option to builder configuration.

4.0.1 #

  • Added support for generic typed parameters for deep copyWith.

4.0.0 #

  • Require sdk: >=3.0.0.

  • Added support for Records.

    • Fields of a class can now be any record type.

    • You can annotate toplevel record typedefs:

        @MappableRecord()
        typedef Coordinates = ({double latitude, double longitude});
      

    For a more detailed usage see the documentation.

3.3.1 #

  • Improved migration docs regarding json_serializable and the difference of toJson().

3.3.0 #

  • Make DateTime encoding configurable through DateTimeMapper.encodingMode.

3.2.0 #

  • Handle bounded nested type parameters in subclasses.

3.1.3 #

  • Fixed set equality.

3.1.2 #

  • Fixed unexpected type error when decoding null.

3.1.1 #

  • Fixed supporting expressions in @MappableClass.includeCustomMappers.

3.1.0 #

  • Fixed error when using non-literal values in @MappableValue().

  • The builder now respects basic initializer expressions of a constructor. This makes it possible to do field renaming or assigning to private fields without requiring an additional getter matching the parameter.

    The following is now supported out of the box:

    class MyClass {
      MyClass(int value, {String? name}) 
          // Effectively renaming 'value' to 'data'.
        : data = value,
          // Assigning to a private field + having a null fallback.
          _name = name ?? 'Unnamed';
    
      final int value;
      final String _name;
    
  • Fixed encoding of a map now returns a Map<String, dynamic> where possible (instead of a Map<dynamic, dynamic>)

3.0.1 #

  • Fixed dependency conflict with package:collection.
  • Added topics for pub.dev.

3.0.0 #

  • Breaking: Generated mappers no longer have a .container property. This was removed in favor of the new MapperContainer.globals container.

    // Instead of this:
    var value = MyClassMapper.container.fromValue(...);
    // Do this:
    var value = MapperContainer.globals.fromValue(...);
    

    Mapper initialization and usage is now simplified to the following:

    1. When used explicitly (e.g. through MyClassMapper.fromMap or myClass.toMap()) no additional initialization is needed.
    2. When used implicitly (through a generic type e.g. MapperContainer.globals.fromMap<MyClass>()) the mapper needs to be initialized once before being used with MyClassMapper.ensureInitialized().
  • Breaking: Changed internal mapper implementation which causes any custom mapper to break.

    • Removed MapperElementBase class.
    • Added MappingContext being passed to mapper methods.

    See docs on how to use custom mappers in v3.

  • Breaking: Removed @MappableLib.createCombinedContainer in favor of @MappableLib.generateInitializerForScope.

    Instead of generating a new container, v3 generates an initialization function for all mappers. Use it early on in your application:

    @MappableLib(generateInitializerForScope: InitializerScope.package)
    library main;
      
    import 'main.init.dart';
      
    void main() {
      initializeMappers();
      ...
    }
    
  • Breaking: Improved support and features for .copyWith.

    • Copy-With now supports classes that implement multiple interfaces.
    • Renamed .copyWith.apply() method to .copyWith.$update().
    • Added .copyWith.$merge() and .copyWith.$delta().

    You can now use .copyWith with either an existing instance using .$merge or a map of values using .$delta.

    @MappableClass()
    class A with AMappable {
      A(this.a, this.b);
        
      int? a;
      int? b;
    }
      
    void main() {
      var a = A(1, null);
        
      var c = a.copyWith.$merge(A(null, 2));
      assert(c == A(1, 2));
      
      var d = a.copyWith.$delta({'b': 2});
      assert(d == A(1, 2));
    }
    
  • Breaking: Removed CheckTypesHook in favor of discriminator functions.

    You can now use a custom predicate function as the discriminatorValue of a class. This function can check whether the encoded value should be decoded to this subclass and return a boolean.

    @MappableClass()
    abstract class A with AMappable {
      A();
    }
      
    @MappableClass(discriminatorValue: B.checkType)
    class B extends A with BMappable {
      B();
        
      /// checks if [value] should be decoded to [B]
      static bool checkType(value) {
        return value is Map && value['isB'] == true;
      }
    }
      
    @MappableClass(discriminatorValue: C.checkType)
    class C extends A with CMappable {
      C();
        
      /// checks if [value] should be decoded to [C]
      static bool checkType(value) {
        return value is Map && value['isWhat'] == 'C';
      }
    }
    
  • Added support for serializing fields that are not part of the constructor when annotated with @MappableField().

  • Added EncodingOptions to toValue method.

  • Added support for third-party models by using annotated typedefs.

  • Added renameMethods to build options.

  • Improved performance of generated encoding and decoding methods.

For a detailed migration guide, see this issue.

2.0.3 #

  • Fixed typo in readme (by @timmaffett)
  • Fixed generated container for private libraries.

2.0.2 #

  • Fixed yet another unresolved type bug.

2.0.1 #

  • Fixed unresolved type bug with custom mappers.

2.0.0 #

  • Mappers are now generated for each file containing annotated classes. This removes the need to specify entry points in the build.yaml.

    This is now similar to how packages like json_serializable or freezed generate code.

    • Generated files are now part files and need to be included as such.
    • All annotated classes must now use their respective <MyClass>Mappable mixin.
    • Instead of one global Mapper each class has its own <ClassName>Mapper.
      • A new global container that includes all models can now be generated using @MappableLib(createCombinedContainer: true).
    • Mappers can be linked together to enable working with multiple classes.
    • Removed @CustomMapper annotation in favor of includeCustomMappers property on @MappableClass().

    For a detailed migration guide, see this issue.

  • Documentation is now separated from the README using the official pub.dev documentation topics. Find the new documentation here

  • Improvements in performance and support for generics and inheritance.

  • Added the [CheckTypesHook] to allow for custom discriminator checks on subclasses in a polymorphic class structure.

  • CopyWith is now more powerful and also works for generic or polymorphic classes, while being completely type-safe.

    When called on a superclass, the concrete subtype will be retained through a .copyWith call, which also respects generics:

      // with `class A` and `class B<T> extends A`
      A a = B<int>(); // static type A, dynamic type B<int>
      
      // signature will be `A copyWith()`, so static type A
      A a2 = a.copyWith(); 
      
      // this will still resolve to a dynamic type of B<int>
      assert(a2 is B<int>);
    

    For more checkout the docs or example

1.2.0 #

  • Added support for 2.17 super parameters

1.1.2 #

  • Improved Readme for constructor utilization
  • Fixed missing imports for custom hooks

1.1.1 #

  • Updated description

1.1.0 #

  • Added support for custom enum values
    • Choose between ValuesMode.named and ValuesMode.indexed for automatic generation of encoded values
    • Use @MappableValue(myCustomValue) on an enum value to specify a custom encoded value
    • Deprecated the String toStringValue() extension method in favor of the more general dynamic toValue()

1.0.3 #

  • Fixed issue with minified standard types on web

1.0.2 #

  • Fixed unrecognized type issue for equals, hashCode and toString methods

1.0.1 #

  • Improved resolving of constructor parameters, which fixed various issues in copyWith and toMap methods
  • Now printing comprehensive warning in the builder output if a parameter cannot be resolved

1.0.0 #

  • Large refactoring and restructuring

    • Restructured builder implementation
    • Moved code out of generated files into package
    • Split package int dart_mappable and dart_mappable_builder
  • Mapper is now a singleton class

    • fromValue, toValue and all other methods are now instance methods accessible with Mapper.i.fromValue()
    • the legacy static methods are still available, but forward to the instance methods
  • Improved Readme, added How to use section and documented copyWith functionalities

  • Added @MappableLib() annotation and moved library-level configuration logic from build options to annotation properties

  • Switched to using the type_plus package for internal handling of generics

  • Added ChainedHooks, UnescapeNewlinesHooks and EmptyToNullHooks

  • Added descriptive and comprehensible exception handling

0.9.1 #

  • Fixed README

0.9.0 #

  • Changed implementation of UnmappedPropertiesHook to allow target parameter at any position in constructor

0.8.7 #

  • Added support for lists in copyWith chains

0.8.6 #

  • Fixed bug in isEquals method

0.8.5 #

  • Restructured and improved tests

0.8.4 #

  • Added get, getAll and useAll methods to Mapper

0.8.3 #

  • Fixed unmapped properties hook

0.8.2 #

  • Fixed enum caseStyle bug

0.8.1 #

  • Fixed missing copyWith implementation bug

0.8.0 #

  • Use CaseStyle in annotations
  • Respect null in copyWith methods
  • Chained copyWith methods

0.7.2 #

  • Fix equals bug

0.7.1 #

  • Deep equality for lists and maps

0.7.0 #

  • Update license

0.6.5 #

  • Fixed imports on windows

0.6.4 #

  • Upgrade dependencies

0.6.3 #

  • Fixed missing default values of constructor parameters

0.6.2 #

  • Added support for factory constructors and sealed classes
  • Added example for usage with freezed package

0.6.1 #

  • Fixed imports issue
  • Fixed platform analysis

0.6.0 #

  • Removed usage-support as dev_dependency in favor of safer generation

0.5.1 #

  • Added @CustomMapper annotation to auto-add custom mappers without needing to do Mapper.use
  • Fixed decoding issue with nullable types
  • Added missing documentation comments

0.5.0 #

  • Reworked configuration system - build.yaml now only support global and library level options
  • Added support for disabling generation of single methods
  • Simplified CustomMappers
  • Improved documentation

0.4.6 #

  • Changed code generation to handle polymorphism explicitly (using switch statement)
  • Fixed issue with multiple levels of inheritance

0.4.5 #

  • Added default enum values

0.4.4 #

  • Added support for class-specific hooks

0.4.3 #

  • Subclasses now inherit field annotations

0.4.2 #

  • Added support for encoding/decoding hooks

0.4.1 #

  • Added support for null and default discriminators
  • Fixed toString generation
  • discriminatorValue can now be any constant expression

0.4.0 #

  • Added support for annotations
  • Added some initial tests

0.3.8 #

  • Added support for custom discriminator values

0.3.7 #

  • Added support for custom iterables and maps
  • Improved documentation on decoding lists, sets and maps

0.3.6 #

  • Added support for abstract classes and polymorphism using type discriminators

0.3.5 #

  • Fixed minified types issue on web

0.3.4 #

  • Ignore classes with only private constructors

0.3.3 #

  • Changed auto_apply to none

0.3.2 #

  • Added support for DateTime

0.3.1 #

  • Conditionally apply ignoreNull

0.3.0 #

  • Generic type support
  • Improved documentation

0.2.1+1 #

  • Fixed formatting
  • Export BuildOptions and CaseStyle classes

0.2.1 #

  • Added support for .toString(), == and hashCode using the Mappable mixin

0.2.0+1 #

  • Changed builder signature

0.2.0 #

  • Support null-safety
  • Added code documentation

0.1.1+1 #

  • Improved example
  • Improved README

0.1.1 #

  • Added initial documentation to README
  • Added yaml configuration options

0.1.0 #

  • Initial development release
215
likes
120
pub points
98%
popularity

Publisher

verified publisherschultek.de

Improved json serialization and data classes with full support for generics, inheritance, customization and more.

Repository (GitHub)
View/report issues

Topics

#json #data-class #codegen #build-runner

Documentation

API reference

Funding

Consider supporting this project:

github.com

License

MIT (LICENSE)

Dependencies

collection, meta, type_plus

More

Packages that depend on dart_mappable