external types: drop property prefix from external field names #139

Author: greenrobot-team

generator/lib/src/code_builder.dart

@@ -213,8 +213,8 @@ class CodeBuilder extends Builder {
     propInModel.dartFieldType = prop.dartFieldType;
     propInModel.relationTarget = prop.relationTarget;
     propInModel.hnswParams = prop.hnswParams;
-    propInModel.externalPropertyType = prop.externalPropertyType;
-    propInModel.externalPropertyName = prop.externalPropertyName;
+    propInModel.externalType = prop.externalType;
+    propInModel.externalName = prop.externalName;
 
     if (!prop.hasIndexFlag()) {
       propInModel.removeIndex();
@@ -244,8 +244,8 @@ class CodeBuilder extends Builder {
 
     relInModel.name = rel.name;
     relInModel.targetName = rel.targetName;
-    relInModel.externalPropertyType = rel.externalPropertyType;
-    relInModel.externalPropertyName = rel.externalPropertyName;
+    relInModel.externalType = rel.externalType;
+    relInModel.externalName = rel.externalName;
   }
 
   IdUid mergeEntity(ModelInfo modelInfo, ModelEntity entity) {

generator/lib/src/code_chunks.dart

@@ -154,13 +154,11 @@ class CodeChunks {
       additionalArgs +=
           ", hnswParams: ${property.hnswParams!.toCodeString(obxInt)}";
     }
-    if (property.externalPropertyType != null) {
-      additionalArgs +=
-          ", externalPropertyType: ${property.externalPropertyType!}";
+    if (property.externalType != null) {
+      additionalArgs += ", externalType: ${property.externalType!}";
     }
-    if (property.externalPropertyName != null) {
-      additionalArgs +=
-          ", externalPropertyName: '${property.externalPropertyName!}'";
+    if (property.externalName != null) {
+      additionalArgs += ", externalName: '${property.externalName!}'";
     }
     return '''
     $obxInt.ModelProperty(
@@ -175,11 +173,11 @@ class CodeChunks {
 
   static String createModelRelation(ModelRelation relation) {
     var additionalArgs = '';
-    if (relation.externalPropertyType != null) {
-      additionalArgs += ", externalType: ${relation.externalPropertyType!}";
+    if (relation.externalType != null) {
+      additionalArgs += ", externalType: ${relation.externalType!}";
     }
-    if (relation.externalPropertyName != null) {
-      additionalArgs += ", externalName: '${relation.externalPropertyName!}'";
+    if (relation.externalName != null) {
+      additionalArgs += ", externalName: '${relation.externalName!}'";
     }
     return '''
     $obxInt.ModelRelation(

generator/lib/src/entity_resolver.dart

@@ -189,28 +189,28 @@ class EntityResolver extends Builder {
         // Handles standalone (non backlink) ToMany relation
 
         // @ExternalType
-        int? externalPropertyType;
+        int? externalType;
         _externalTypeChecker.runIfMatches(annotated, (annotation) {
           final externalTypeId = _readExternalTypeParams(annotation);
-          externalPropertyType = externalTypeId;
+          externalType = externalTypeId;
         });
 
         // @ExternalName
-        String? externalPropertyName;
+        String? externalName;
         _externalNameChecker.runIfMatches(annotated, (annotation) {
-          if (externalPropertyType == null) {
+          if (externalType == null) {
             throw InvalidGenerationSourceError(
                 "@ExternalName annotation requires @ExternalType annotation to be present");
           }
-          externalPropertyName = _readExternalNameParams(annotation);
+          externalName = _readExternalNameParams(annotation);
         });
 
         // create relation
         final rel = ModelRelation.create(IdUid(0, propUid ?? 0), f.name,
             targetName: relTargetName,
             uidRequest: propUid != null && propUid == 0,
-            externalPropertyName: externalPropertyName,
-            externalPropertyType: externalPropertyType);
+            externalName: externalName,
+            externalType: externalType);
 
         entity.relations.add(rel);
 
@@ -255,17 +255,17 @@ class EntityResolver extends Builder {
         // @ExternalType
         _externalTypeChecker.runIfMatches(annotated, (annotation) {
           final externalTypeId = _readExternalTypeParams(annotation);
-          prop.externalPropertyType = externalTypeId;
+          prop.externalType = externalTypeId;
         });
 
         // @ExternalName
         _externalNameChecker.runIfMatches(annotated, (annotation) {
-          if (prop.externalPropertyType == null) {
+          if (prop.externalType == null) {
             throw InvalidGenerationSourceError(
                 "@ExternalName annotation requires @ExternalType annotation to be present");
           }
           final externalName = _readExternalNameParams(annotation);
-          prop.externalPropertyName = externalName;
+          prop.externalName = externalName;
         });
 
         // for code generation

generator/test/code_builder_test.dart

@@ -405,12 +405,12 @@ void main() {
 
       final property1 = testEnv.model.entities[0].properties
           .firstWhere((element) => element.name == "mongoId");
-      expect(property1.externalPropertyType, OBXExternalPropertyType.MongoId);
+      expect(property1.externalType, OBXExternalPropertyType.MongoId);
 
       final property2 = testEnv.model.entities[0].properties
           .firstWhere((element) => element.name == "mongoUuid");
-      expect(property2.externalPropertyType, OBXExternalPropertyType.Uuid);
-      expect(property2.externalPropertyName, "my-mongo-uuid");
+      expect(property2.externalType, OBXExternalPropertyType.Uuid);
+      expect(property2.externalName, "my-mongo-uuid");
     });
 
     test('annotations work on ToMany (standalone) relations', () async {
@@ -436,12 +436,12 @@ void main() {
 
       final relation1 = testEnv.model.entities[0].relations
           .firstWhere((element) => element.name == "rel1");
-      expect(relation1.externalPropertyType, OBXExternalPropertyType.MongoId);
+      expect(relation1.externalType, OBXExternalPropertyType.MongoId);
 
       final relation2 = testEnv.model.entities[0].relations
           .firstWhere((element) => element.name == "rel2");
-      expect(relation2.externalPropertyType, OBXExternalPropertyType.Uuid);
-      expect(relation2.externalPropertyName, "my-courses-rel");
+      expect(relation2.externalType, OBXExternalPropertyType.Uuid);
+      expect(relation2.externalName, "my-courses-rel");
     });
   });
 

objectbox/lib/src/modelinfo/modelproperty.dart

@@ -16,8 +16,8 @@ class ModelProperty {
   ModelEntity? entity;
   String? relationTarget;
   ModelHnswParams? hnswParams;
-  int? externalPropertyType;
-  String? externalPropertyName;
+  int? externalType;
+  String? externalName;
 
   /// Type used in the source dart code - used by the code generator.
   /// Starts with [_fieldReadOnlyPrefix] if the field (currently IDs only) is
@@ -117,8 +117,8 @@ class ModelProperty {
       IdUid? indexId,
       this.relationTarget,
       this.hnswParams,
-      this.externalPropertyName,
-      this.externalPropertyType})
+      this.externalName,
+      this.externalType})
       : _name = name,
         _type = type,
         _flags = flags,
@@ -132,8 +132,8 @@ class ModelProperty {
         uidRequest = data['uidRequest'] as bool? ?? false,
         hnswParams = ModelHnswParams.fromMap(
             data['hnswParams'] as Map<String, dynamic>?),
-        externalPropertyType = data['externalType'] as int?,
-        externalPropertyName = data['externalName'] as String? {
+        externalType = data['externalType'] as int?,
+        externalName = data['externalName'] as String? {
     name = data['name'] as String?;
     type = data['type'] as int?;
     flags = data['flags'] as int? ?? 0;
@@ -157,11 +157,11 @@ class ModelProperty {
       if (hnswParams != null) {
         ret['hnswParams'] = hnswParams!.toMap();
       }
-      if (externalPropertyType != null) {
-        ret['externalType'] = externalPropertyType;
+      if (externalType != null) {
+        ret['externalType'] = externalType;
       }
-      if (externalPropertyName != null) {
-        ret['externalName'] = externalPropertyName;
+      if (externalName != null) {
+        ret['externalName'] = externalName;
       }
     }
     return ret;

objectbox/lib/src/modelinfo/modelrelation.dart

@@ -12,8 +12,8 @@ class ModelRelation {
 
   String? _targetName;
 
-  int? externalPropertyType;
-  String? externalPropertyName;
+  int? externalType;
+  String? externalName;
 
   // whether the user requested UID information (started a rename process)
   final bool uidRequest;
@@ -49,17 +49,17 @@ class ModelRelation {
   ModelRelation.create(this.id, String? name,
       {String? targetId,
       String? targetName,
-      int? externalPropertyType,
-      String? externalPropertyName,
+      int? externalType,
+      String? externalName,
       this.uidRequest = false}) {
     this.name = name;
     if (targetId != null) this.targetId = IdUid.fromString(targetId);
     if (targetName != null) this.targetName = targetName;
-    if (externalPropertyType != null) {
-      this.externalPropertyType = externalPropertyType;
+    if (externalType != null) {
+      this.externalType = externalType;
     }
-    if (externalPropertyName != null) {
-      this.externalPropertyName = externalPropertyName;
+    if (externalName != null) {
+      this.externalName = externalName;
     }
   }
 
@@ -80,18 +80,20 @@ class ModelRelation {
             targetId: data['targetId'] as String?,
             targetName: data['targetName'] as String?,
             uidRequest: data['uidRequest'] as bool? ?? false,
-            externalPropertyType: data['externalType'] as int?,
-            externalPropertyName: data['externalName'] as String?);
+            externalType: data['externalType'] as int?,
+            externalName: data['externalName'] as String?);
 
   Map<String, dynamic> toMap({bool forModelJson = false}) {
     final ret = <String, dynamic>{};
     ret['id'] = id.toString();
     ret['name'] = name;
     if (_targetId != null) ret['targetId'] = _targetId.toString();
-    if (externalPropertyType != null)
-      ret['externalType'] = externalPropertyType;
-    if (externalPropertyName != null)
-      ret['externalName'] = externalPropertyName;
+    if (externalType != null) {
+      ret['externalType'] = externalType;
+    }
+    if (externalName != null) {
+      ret['externalName'] = externalName;
+    }
     if (!forModelJson) {
       ret['targetName'] = _targetName;
       ret['uidRequest'] = uidRequest;

objectbox/lib/src/native/model.dart

@@ -116,34 +116,31 @@ class Model {
       }
     }
 
-    final externalPropertyType = prop.externalPropertyType;
-    if (externalPropertyType != null) {
-      _check(C.model_property_external_type(_cModel, externalPropertyType));
+    final externalType = prop.externalType;
+    if (externalType != null) {
+      _check(C.model_property_external_type(_cModel, externalType));
     }
-    final externalPropertyName = prop.externalPropertyName?.toNativeUtf8();
-    if (externalPropertyName != null) {
+    final externalName = prop.externalName?.toNativeUtf8();
+    if (externalName != null) {
       try {
-        _check(C.model_property_external_name(
-            _cModel, externalPropertyName.cast()));
+        _check(C.model_property_external_name(_cModel, externalName.cast()));
       } finally {
-        calloc.free(externalPropertyName);
+        calloc.free(externalName);
       }
     }
   }
 
   void addRelation(ModelRelation rel) {
     _check(C.model_relation(
         _cModel, rel.id.id, rel.id.uid, rel.targetId.id, rel.targetId.uid));
-    if (rel.externalPropertyType != null) {
-      _check(
-          C.model_relation_external_type(_cModel, rel.externalPropertyType!));
-      if (rel.externalPropertyName != null) {
-        final externalPropertyName = rel.externalPropertyName!.toNativeUtf8();
+    if (rel.externalType != null) {
+      _check(C.model_relation_external_type(_cModel, rel.externalType!));
+      if (rel.externalName != null) {
+        final externalName = rel.externalName!.toNativeUtf8();
         try {
-          _check(C.model_relation_external_name(
-              _cModel, externalPropertyName.cast()));
+          _check(C.model_relation_external_name(_cModel, externalName.cast()));
         } finally {
-          calloc.free(externalPropertyName);
+          calloc.free(externalName);
         }
       }
     }