feat: Add JsonSerializable(createJsonMeta) (#1164)

As discussed before, this adds an option for generating a constant Map of property name: json name

fixes #972

json_annotation/CHANGELOG.md

@@ -1,5 +1,7 @@
 ## 4.6.0
 
+- Added `JsonSerializable(createFieldMap: true)`.
+  ([#1164](https://github.com/google/json_serializable.dart/pull/1164))
 - Added `JsonSerializable(converters: <JsonConverter>[])`
   ([#1072](https://github.com/google/json_serializable.dart/issues/1072))
 

json_annotation/lib/src/json_serializable.dart

@@ -6,6 +6,7 @@ import 'package:meta/meta_meta.dart';
 
 import 'allowed_keys_helpers.dart';
 import 'checked_helpers.dart';
+import 'enum_helpers.dart';
 import 'json_converter.dart';
 import 'json_key.dart';
 
@@ -79,6 +80,13 @@ class JsonSerializable {
   /// ```
   final bool? createFactory;
 
+  /// If `true` (defaults to false), a private, static `_$ExampleJsonMeta`
+  /// constant is created in the generated part file.
+  ///
+  /// This constant can be used by other code-generators to support features
+  /// such as [fieldRename].
+  final bool? createFieldMap;
+
   /// If `true` (the default), A top-level function is created that you can
   /// reference from your class.
   ///
@@ -231,6 +239,7 @@ class JsonSerializable {
     this.anyMap,
     this.checked,
     this.constructor,
+    this.createFieldMap,
     this.createFactory,
     this.createToJson,
     this.disallowUnrecognizedKeys,

json_serializable/CHANGELOG.md

@@ -1,3 +1,9 @@
+## 6.3.1-dev
+
+- Added support for generating `_$ExampleFieldMeta`, which can be used by other
+  code-generators that needs to interact with the JSON serialization.
+  ([#1164](https://github.com/google/json_serializable.dart/pull/1164))
+
 ## 6.3.0-dev
 
 - Added support for using a `JsonConverter<MyClass, Object>` on properties

json_serializable/README.md

@@ -179,6 +179,7 @@ targets:
           checked: false
           constructor: ""
           create_factory: true
+          create_field_map: false
           create_to_json: true
           disallow_unrecognized_keys: false
           explicit_to_json: false

json_serializable/lib/src/encoder_helper.dart

@@ -16,6 +16,27 @@ import 'unsupported_type_error.dart';
 abstract class EncodeHelper implements HelperCore {
   String _fieldAccess(FieldElement field) => '$_toJsonParamName.${field.name}';
 
+  /// Generates an object containing metadatas related to the encoding,
+  /// destined to be used by other code-generators.
+  String createFieldMap(Set<FieldElement> accessibleFieldSet) {
+    assert(config.createFieldMap);
+
+    final buffer = StringBuffer(
+      'const _\$${element.name.nonPrivate}FieldMap = <String, String> {',
+    );
+
+    for (final field in accessibleFieldSet) {
+      buffer.writeln(
+        '${escapeDartString(field.name)}: '
+        '${escapeDartString(nameAccess(field))},',
+      );
+    }
+
+    buffer.write('};');
+
+    return buffer.toString();
+  }
+
   Iterable<String> createToJson(Set<FieldElement> accessibleFields) sync* {
     assert(config.createToJson);
 

json_serializable/lib/src/generator_helper.dart

@@ -108,6 +108,10 @@ class GeneratorHelper extends HelperCore with EncodeHelper, DecodeHelper {
       },
     );
 
+    if (config.createFieldMap) {
+      yield createFieldMap(accessibleFieldSet);
+    }
+
     if (config.createToJson) {
       yield* createToJson(accessibleFieldSet);
     }

json_serializable/lib/src/type_helpers/config_types.dart

@@ -45,6 +45,7 @@ class ClassConfig {
   final String constructor;
   final bool createFactory;
   final bool createToJson;
+  final bool createFieldMap;
   final bool disallowUnrecognizedKeys;
   final bool explicitToJson;
   final FieldRename fieldRename;
@@ -60,6 +61,7 @@ class ClassConfig {
     required this.constructor,
     required this.createFactory,
     required this.createToJson,
+    required this.createFieldMap,
     required this.disallowUnrecognizedKeys,
     required this.explicitToJson,
     required this.fieldRename,
@@ -76,6 +78,8 @@ class ClassConfig {
         checked: config.checked ?? ClassConfig.defaults.checked,
         anyMap: config.anyMap ?? ClassConfig.defaults.anyMap,
         constructor: config.constructor ?? ClassConfig.defaults.constructor,
+        createFieldMap:
+            config.createFieldMap ?? ClassConfig.defaults.createFieldMap,
         createFactory:
             config.createFactory ?? ClassConfig.defaults.createFactory,
         createToJson: config.createToJson ?? ClassConfig.defaults.createToJson,
@@ -101,6 +105,7 @@ class ClassConfig {
     constructor: '',
     createFactory: true,
     createToJson: true,
+    createFieldMap: false,
     disallowUnrecognizedKeys: false,
     explicitToJson: false,
     fieldRename: FieldRename.none,
@@ -115,6 +120,7 @@ class ClassConfig {
         constructor: constructor,
         createFactory: createFactory,
         createToJson: createToJson,
+        createFieldMap: createFieldMap,
         ignoreUnannotated: ignoreUnannotated,
         explicitToJson: explicitToJson,
         includeIfNull: includeIfNull,

json_serializable/lib/src/utils.dart

@@ -56,6 +56,7 @@ JsonSerializable _valueForAnnotation(ConstantReader reader) => JsonSerializable(
       constructor: reader.read('constructor').literalValue as String?,
       createFactory: reader.read('createFactory').literalValue as bool?,
       createToJson: reader.read('createToJson').literalValue as bool?,
+      createFieldMap: reader.read('createFieldMap').literalValue as bool?,
       disallowUnrecognizedKeys:
           reader.read('disallowUnrecognizedKeys').literalValue as bool?,
       explicitToJson: reader.read('explicitToJson').literalValue as bool?,
@@ -101,6 +102,7 @@ ClassConfig mergeConfig(
     constructor: constructor,
     createFactory: annotation.createFactory ?? config.createFactory,
     createToJson: annotation.createToJson ?? config.createToJson,
+    createFieldMap: annotation.createFieldMap ?? config.createFieldMap,
     disallowUnrecognizedKeys:
         annotation.disallowUnrecognizedKeys ?? config.disallowUnrecognizedKeys,
     explicitToJson: annotation.explicitToJson ?? config.explicitToJson,

json_serializable/pubspec.yaml

@@ -1,5 +1,5 @@
 name: json_serializable
-version: 6.3.0-dev
+version: 6.3.1-dev
 description: >-
   Automatically generate code for converting to and from JSON by annotating
   Dart classes.

json_serializable/test/config_test.dart

@@ -126,6 +126,10 @@ void main() {
             lastLine = "type 'int' is not a subtype of type 'String?' in type "
                 'cast';
             break;
+          case 'create_to_json':
+            lastLine = "type 'int' is not a subtype of type 'bool?' in type "
+                'cast';
+            break;
           default:
             lastLine =
                 "type 'int' is not a subtype of type 'bool?' in type cast";
@@ -152,6 +156,7 @@ const _invalidConfig = {
   'checked': 42,
   'constructor': 42,
   'create_factory': 42,
+  'create_field_map': 42,
   'create_to_json': 42,
   'disallow_unrecognized_keys': 42,
   'explicit_to_json': 42,

json_serializable/test/integration/field_map_example.dart

@@ -0,0 +1,43 @@
+import 'package:json_annotation/json_annotation.dart';
+
+part 'field_map_example.g.dart';
+
+@JsonSerializable(createFieldMap: true, fieldRename: FieldRename.kebab)
+class Model {
+  Model({
+    required this.firstName,
+    required this.lastName,
+    this.ignoredName,
+  });
+
+  factory Model.fromJson(Map<String, Object?> json) => _$ModelFromJson(json);
+
+  final String firstName;
+
+  @JsonKey(name: 'LAST_NAME')
+  final String lastName;
+
+  @JsonKey(ignore: true)
+  final String? ignoredName;
+
+  String get fullName => '$firstName $lastName';
+
+  Map<String, Object?> toJson() => _$ModelToJson(this);
+}
+
+const modelFieldMap = _$ModelFieldMap;
+
+@JsonSerializable(
+  createFieldMap: true,
+  fieldRename: FieldRename.kebab,
+  createFactory: false,
+)
+class _PrivateModel {
+  _PrivateModel(this.fullName);
+
+  final String fullName;
+
+  Map<String, Object?> toJson() => _$PrivateModelToJson(this);
+}
+
+const privateModelFieldMap = _$PrivateModelFieldMap;

json_serializable/test/integration/integration_test.dart

@@ -6,6 +6,7 @@ import 'package:json_annotation/json_annotation.dart';
 import 'package:test/test.dart';
 
 import '../test_utils.dart';
+import 'field_map_example.dart';
 import 'json_enum_example.dart';
 import 'json_test_common.dart' show Category, Platform, StatusCode;
 import 'json_test_example.dart';
@@ -339,4 +340,22 @@ void main() {
       isNull,
     );
   });
+
+  test(r'_$ModelFieldMap', () {
+    expect(
+      modelFieldMap,
+      {
+        'firstName': 'first-name',
+        'lastName': 'LAST_NAME',
+      },
+    );
+  });
+
+  test(r'Generates _$PrivateModelFieldMap instead of __$PrivateModelFieldMap',
+      () {
+    expect(
+      privateModelFieldMap,
+      {'fullName': 'full-name'},
+    );
+  });
 }

json_serializable/test/shared_config.dart

@@ -19,6 +19,7 @@ final generatorConfigNonDefaultJson =
   constructor: 'something',
   createFactory: false,
   createToJson: false,
+  createFieldMap: true,
   disallowUnrecognizedKeys: true,
   explicitToJson: true,
   fieldRename: FieldRename.kebab,

json_serializable/test/test_sources/test_sources.dart

@@ -15,6 +15,7 @@ class ConfigurationImplicitDefaults {
   constructor: '',
   createFactory: true,
   createToJson: true,
+  createFieldMap: false,
   disallowUnrecognizedKeys: false,
   explicitToJson: false,
   fieldRename: FieldRename.none,

json_serializable/tool/readme/readme_template.md

@@ -137,6 +137,7 @@ targets:
           checked: false
           constructor: ""
           create_factory: true
+          create_field_map: false
           create_to_json: true
           disallow_unrecognized_keys: false
           explicit_to_json: false