Feat: Support passing in enums into TypedExtras (#708)

* Feat: Allow passing in enums into TypedExtras * update version and changelog
trevorwang · Sep 11, 2024 · 6d61839 · 6d61839
1 parent 89941db
commit 6d61839
Show file tree

Hide file tree

Showing 4 changed files with 31 additions and 8 deletions.
diff --git a/generator/CHANGELOG.md b/generator/CHANGELOG.md
@@ -1,5 +1,21 @@
 # Changelog
 
+## 9.1.2
+
+- Support passing Enums into `TypedExtras`.
+
+  Example :
+
+  ```dart
+  @TypedExtrasSubClass(
+    id: 'abcd',
+    fileType: FileType.json,
+    destinations: [Destination.remote]
+  )
+  @http.POST('/path/')
+  Future<String> myMethod();
+  ```
+
 ## 9.1.0
 
 - Added `@TypedExtras` to pass extra options to dio requests using custom annotations.

diff --git a/generator/lib/src/generator.dart b/generator/lib/src/generator.dart
@@ -2276,6 +2276,9 @@ ${bodyName.displayName} == null
     if (value?.isDouble ?? false) return value?.doubleValue;
     if (value?.isInt ?? false) return value?.intValue;
     if (value?.isString ?? false) return value?.stringValue;
+    if (value?.objectValue.isEnum ?? false) {
+      return value?.objectValue.variable?.displayName;
+    }
     if (value?.isList ?? false) {
       return value?.listValue
           .map((item) => _getFieldValue(ConstantReader(item)))
@@ -2624,6 +2627,12 @@ extension DartTypeExt on DartType {
   }
 }
 
+extension DartObjectX on DartObject? {
+  bool get isEnum {
+    return this?.type?.element?.kind.name == 'ENUM';
+  }
+}
+
 extension ReferenceExt on Reference {
   Reference asNoNull() => refer('$symbol!');
 

diff --git a/generator/pubspec.yaml b/generator/pubspec.yaml
@@ -8,7 +8,7 @@ topics:
   - rest
   - retrofit
   - codegen
-version: 9.1.1
+version: 9.1.2
 environment:
   sdk: '>=3.3.0 <4.0.0'
 

diff --git a/generator/test/src/generator_test_src.dart b/generator/test/src/generator_test_src.dart
@@ -6,14 +6,14 @@ import 'package:source_gen_test/annotations.dart';
 
 import 'query.pb.dart';
 
+enum FileType {mp4, mp3}
 class DummyTypedExtras extends TypedExtras {
   final String id;
   final Map<String, dynamic> config;
-  final List<String> fileTypes;
+  final List<FileType> fileTypes;
   final Set<String> sources;
   final bool shouldProceed;
   final bool? canFly;
-
   const DummyTypedExtras({
     required this.id,
     required this.config,
@@ -35,9 +35,8 @@ class DummyTypedExtras extends TypedExtras {
         'subConfig': {'date': '24-11-2025'},
       },
       'fileTypes': [
-        'mp4',
         'mp3',
-        'mkv',
+        'mp4',
       ],
       'sources': {
         'internet',
@@ -59,9 +58,8 @@ abstract class TypedExtrasTest {
       'subConfig': {'date': '24-11-2025'},
     },
     fileTypes: [
-      'mp4',
-      'mp3',
-      'mkv',
+      FileType.mp3,
+      FileType.mp4,
     ],
     sources: {
       'internet',