docs: bump version number and update documentation

Author: O-Hannonen

example/pubspec.yaml

@@ -7,7 +7,7 @@ environment:
 resolution: workspace
 
 dependencies:
-  json_annotation: ^4.9.0
+  json_annotation: ^4.10.0
 
 dev_dependencies:
   # Used by tests. Not required to use `json_serializable`.
@@ -21,7 +21,7 @@ dev_dependencies:
   build_verify: ^3.0.0
 
   # REQUIRED!
-  json_serializable: ^6.8.0
+  json_serializable: ^6.10.0
 
   # Not required to use `json_serializable`.
   path: ^1.8.0

json_annotation/CHANGELOG.md

@@ -1,3 +1,8 @@
+## 4.10.0
+
+- Add `JsonSerializable.unionRename`
+- Add `JsonSerializable.unionDiscriminator`
+
 ## 4.9.1-wip
 
 - Require Dart 3.6

json_annotation/pubspec.yaml

@@ -1,5 +1,5 @@
 name: json_annotation
-version: 4.9.1-wip
+version: 4.10.0
 description: >-
   Classes and helper functions that support JSON code generation via the
   `json_serializable` package.

json_serializable/CHANGELOG.md

@@ -1,3 +1,8 @@
+## 6.10.0
+
+- Add support for deserializing union json to sealed class
+- Add support for serializing sealed class to union json
+
 ## 6.9.4
 
 - Fix extra line being generated when targetting Dart 3.7 package.

json_serializable/README.md

@@ -256,6 +256,53 @@ customize the encoding/decoding of any type, you have a few options.
     }
     ```
 
+# Sealed classes
+
+As of [`json_serializable`] version 6.10.0 and [`json_annotation`]
+version 4.10.0, sealed classes can be serialized to json unions and json unions
+can be deserialized to sealed classes.
+
+To achieve this, both the sealed class and its subclasses should be annotated
+with `JsonSerializable`. Only the sealed class should have `fromJson` factory
+and `toJson` functions. To customize the sealed class behavior, use the fields
+`unionRename` and `unionDiscriminator` in `JsonSerializable` or adjust the
+default behavior by changing the corresponding fields in `build.yaml`. For
+more complex examples, please see [example]:
+
+```dart
+import 'package:json_annotation/json_annotation.dart';
+
+part 'sealed_example.g.dart';
+
+@JsonSerializable()
+sealed class SealedBase {
+  const SealedBase();
+
+  factory SealedBase.fromJson(Map<String, dynamic> json) =>
+      _$SealedBaseFromJson(json);
+
+  Map<String, dynamic> toJson() => _$SealedBaseToJson(this);
+}
+
+@JsonSerializable()
+class SealedSub1 extends SealedBase {
+  final String exampleField1;
+
+  SealedSub1({
+    required this.exampleField1,
+  });
+}
+
+@JsonSerializable()
+class SealedSub2 extends SealedBase {
+  final String exampleField2;
+
+  SealedSub2({
+    required this.exampleField2,
+  });
+}
+```
+
 # Build configuration
 
 Aside from setting arguments on the associated annotation classes, you can also
@@ -312,15 +359,17 @@ targets:
 [`Enum`]: https://api.dart.dev/dart-core/Enum-class.html
 [`int`]: https://api.dart.dev/dart-core/int-class.html
 [`Iterable`]: https://api.dart.dev/dart-core/Iterable-class.html
-[`JsonConverter`]: https://pub.dev/documentation/json_annotation/latest/json_annotation/JsonConverter-class.html
-[`JsonEnum.valueField`]: https://pub.dev/documentation/json_annotation/latest/json_annotation/JsonEnum/valueField.html
-[`JsonEnum`]: https://pub.dev/documentation/json_annotation/latest/json_annotation/JsonEnum-class.html
-[`JsonKey.fromJson`]: https://pub.dev/documentation/json_annotation/latest/json_annotation/JsonKey/fromJson.html
-[`JsonKey.toJson`]: https://pub.dev/documentation/json_annotation/latest/json_annotation/JsonKey/toJson.html
-[`JsonKey`]: https://pub.dev/documentation/json_annotation/latest/json_annotation/JsonKey-class.html
-[`JsonLiteral`]: https://pub.dev/documentation/json_annotation/latest/json_annotation/JsonLiteral-class.html
-[`JsonSerializable`]: https://pub.dev/documentation/json_annotation/latest/json_annotation/JsonSerializable-class.html
-[`JsonValue`]: https://pub.dev/documentation/json_annotation/latest/json_annotation/JsonValue-class.html
+[`json_annotation`]: https://unknown.com/package/json_annotation
+[`json_serializable`]: https://unknown.com/package/json_serializable
+[`JsonConverter`]: https://pub.dev/documentation/json_annotation/4.10.0/json_annotation/JsonConverter-class.html
+[`JsonEnum.valueField`]: https://pub.dev/documentation/json_annotation/4.10.0/json_annotation/JsonEnum/valueField.html
+[`JsonEnum`]: https://pub.dev/documentation/json_annotation/4.10.0/json_annotation/JsonEnum-class.html
+[`JsonKey.fromJson`]: https://pub.dev/documentation/json_annotation/4.10.0/json_annotation/JsonKey/fromJson.html
+[`JsonKey.toJson`]: https://pub.dev/documentation/json_annotation/4.10.0/json_annotation/JsonKey/toJson.html
+[`JsonKey`]: https://pub.dev/documentation/json_annotation/4.10.0/json_annotation/JsonKey-class.html
+[`JsonLiteral`]: https://pub.dev/documentation/json_annotation/4.10.0/json_annotation/JsonLiteral-class.html
+[`JsonSerializable`]: https://pub.dev/documentation/json_annotation/4.10.0/json_annotation/JsonSerializable-class.html
+[`JsonValue`]: https://pub.dev/documentation/json_annotation/4.10.0/json_annotation/JsonValue-class.html
 [`List`]: https://api.dart.dev/dart-core/List-class.html
 [`Map`]: https://api.dart.dev/dart-core/Map-class.html
 [`num`]: https://api.dart.dev/dart-core/num-class.html

json_serializable/example/sealed_example.dart

@@ -0,0 +1,31 @@
+import 'package:json_annotation/json_annotation.dart';
+
+part 'sealed_example.g.dart';
+
+@JsonSerializable()
+sealed class SealedBase {
+  const SealedBase();
+
+  factory SealedBase.fromJson(Map<String, dynamic> json) =>
+      _$SealedBaseFromJson(json);
+
+  Map<String, dynamic> toJson() => _$SealedBaseToJson(this);
+}
+
+@JsonSerializable()
+class SealedSub1 extends SealedBase {
+  final String exampleField1;
+
+  SealedSub1({
+    required this.exampleField1,
+  });
+}
+
+@JsonSerializable()
+class SealedSub2 extends SealedBase {
+  final String exampleField2;
+
+  SealedSub2({
+    required this.exampleField2,
+  });
+}

json_serializable/example/sealed_example.g.dart

@@ -1,5 +1,5 @@
 name: json_serializable
-version: 6.9.4
+version: 6.10.0
 description: >-
   Automatically generate code for converting to and from JSON by annotating
   Dart classes.
@@ -24,7 +24,7 @@ dependencies:
 
   # Use a tight version constraint to ensure that a constraint on
   # `json_annotation` properly constrains all features it provides.
-  json_annotation: '>=4.9.0 <4.10.0'
+  json_annotation: '>=4.10.0 <4.11.0'
   meta: ^1.14.0
   path: ^1.9.0
   pub_semver: ^2.1.4

json_serializable/pubspec.yaml

@@ -121,6 +121,21 @@ customize the encoding/decoding of any type, you have a few options.
 
     <!-- REPLACE tool/readme/readme_examples.dart-json_converter -->
 
+# Sealed classes
+
+As of `package:json_serializable` version 6.10.0 and `package:json_annotation`
+version 4.10.0, sealed classes can be serialized to json unions and json unions
+can be deserialized to sealed classes.
+
+To achieve this, both the sealed class and its subclasses should be annotated
+with `JsonSerializable`. Only the sealed class should have `fromJson` factory
+or `toJson` function. To customize the sealed class behavior, use the fields
+`unionRename` and `unionDiscriminator` in `JsonSerializable` or adjust the
+default behavior by changing the corresponding fields in `build.yaml`. For
+more complex examples, please see [example]:
+
+<!-- REPLACE example/sealed_example.dart -->
+
 # Build configuration
 
 Aside from setting arguments on the associated annotation classes, you can also

json_serializable/tool/readme/readme_template.md

@@ -25,6 +25,7 @@ class _ReadmeBuilder extends Builder {
       ...await buildStep.getExampleContent('example/example.dart'),
       ...await buildStep.getExampleContent('example/example.g.dart'),
       ...await buildStep.getExampleContent('tool/readme/readme_examples.dart'),
+      ...await buildStep.getExampleContent('example/sealed_example.dart'),
       'supported_types': _classCleanAndSort(supportedTypes()),
       'collection_types': _classCleanAndSort(collectionTypes()),
       'map_key_types': _classCleanAndSort(mapKeyTypes),