fix: misc

Author: fulleni

lib/src/models/feed/engagement_content.dart

@@ -23,8 +23,8 @@ class EngagementContent extends FeedItem {
     String? id,
   })  : id = id ?? const Uuid().v4(),
         super(
-            type:
-                'engagement_content',); // Removed action from super constructor
+          type: 'engagement_content',
+        ); // Removed action from super constructor
 
   /// Factory method to create an [EngagementContent] instance from a JSON map.
   factory EngagementContent.fromJson(Map<String, dynamic> json) {

lib/src/models/feed/suggested_content.dart

@@ -25,7 +25,8 @@ class SuggestedContent extends FeedItem {
     String? id,
   })  : id = id ?? const Uuid().v4(),
         super(
-            type: 'suggested_content',); // Removed action from super constructor
+          type: 'suggested_content',
+        ); // Removed action from super constructor
 
   /// Factory method to create a [SuggestedContent] instance from a JSON map.
   factory SuggestedContent.fromJson(Map<String, dynamic> json) {
@@ -91,7 +92,8 @@ class SuggestedContent extends FeedItem {
           return e.toJson();
         }
         throw FormatException(
-            'Unknown item type for serialization: ${e.runtimeType}',);
+          'Unknown item type for serialization: ${e.runtimeType}',
+        );
       }).toList(),
       'action': action.toJson(),
       'type': type, // Inherited from FeedItem

lib/src/models/remote-config/ad_config.dart

@@ -1,8 +1,10 @@
 import 'package:equatable/equatable.dart';
 import 'package:ht_shared/ht_shared.dart' show AppConfig;
 import 'package:ht_shared/src/models/models.dart' show AppConfig;
-import 'package:ht_shared/src/models/remote-config/app_config.dart' show AppConfig;
-import 'package:ht_shared/src/models/remote-config/remote_config.dart' show AppConfig;
+import 'package:ht_shared/src/models/remote-config/app_config.dart'
+    show AppConfig;
+import 'package:ht_shared/src/models/remote-config/remote_config.dart'
+    show AppConfig;
 
 /// {@template ad_config}
 /// Defines configuration settings related to ad injection and display,

lib/src/models/remote-config/user_preference_limits.dart

@@ -1,6 +1,8 @@
 import 'package:equatable/equatable.dart';
-import 'package:ht_shared/ht_shared.dart' show AppConfig, UserContentPreferences;
-import 'package:ht_shared/src/models/models.dart' show AppConfig, UserContentPreferences;
+import 'package:ht_shared/ht_shared.dart'
+    show AppConfig, UserContentPreferences;
+import 'package:ht_shared/src/models/models.dart'
+    show AppConfig, UserContentPreferences;
 import 'package:meta/meta.dart';
 
 /// {@template user_preference_limits}

lib/src/utils/json_converters.dart

@@ -1,5 +1,6 @@
 import 'package:ht_shared/ht_shared.dart';
 import 'package:ht_shared/src/models/content_type.dart';
+import 'package:ht_shared/src/models/feed/feed_item_action.dart';
 
 /// Converts a snake_case string to a [ContentType] enum value.
 ///
@@ -377,3 +378,33 @@ String adTypeToJson(AdType type) {
       return 'interstitial';
   }
 }
+
+/// Converts a JSON map to a [FeedItemAction] instance.
+///
+/// This function acts as a central deserializer for the sealed [FeedItemAction]
+/// class, dispatching to the correct subtype's `fromJson` constructor based
+/// on the 'type' field in the JSON.
+///
+/// Throws a [FormatException] if the 'type' is unknown or if the JSON
+/// structure is invalid for the determined subtype.
+FeedItemAction feedItemActionFromJson(Map<String, dynamic> json) {
+  final type = json['type'] as String;
+  switch (type) {
+    case 'open_internal_content':
+      return OpenInternalContent.fromJson(json);
+    case 'show_interstitial_then_open_internal_content':
+      return ShowInterstitialThenOpenInternalContent.fromJson(json);
+    case 'open_external_url':
+      return OpenExternalUrl.fromJson(json);
+    default:
+      throw FormatException('Unknown FeedItemAction type: $type');
+  }
+}
+
+/// Converts a [FeedItemAction] instance to a JSON map.
+///
+/// This function acts as a central serializer for the sealed [FeedItemAction]
+/// class, dispatching to the correct subtype's `toJson` method.
+String feedItemActionToJson(FeedItemAction action) {
+  return action.toJson()['type'] as String;
+}

pubspec.lock

@@ -258,7 +258,7 @@ packages:
     source: hosted
     version: "0.7.2"
   json_annotation:
-    dependency: transitive
+    dependency: "direct main"
     description:
       name: json_annotation
       sha256: "1ce844379ca14835a50d2f019a3099f419082cfdd231cd86a142af94dd5c6bb1"

pubspec.yaml

@@ -8,6 +8,7 @@ environment:
 
 dependencies:
   equatable: ^2.0.7
+  json_annotation: ^4.9.0
   meta: ^1.17.0
   uuid: ^4.5.1
 

test/src/models/feed/ad_test.dart

@@ -12,15 +12,14 @@ void main() {
     const testTargetUrl = 'http://example.com/target';
     const testAdType = AdType.banner;
     const testPlacement = AdPlacement.feedInlineStandardBanner;
-    const defaultAction = OpenExternalUrl(url: 'http://default.com');
+    final defaultAction = OpenExternalUrl(url: 'http://default.com');
 
     Ad createSubject({
-      String? id,
+      required FeedItemAction action, String? id,
       String imageUrl = testImageUrl,
       String targetUrl = testTargetUrl,
       AdType adType = testAdType,
       AdPlacement? placement = testPlacement,
-      FeedItemAction action = defaultAction,
     }) {
       return Ad(
         id: id,
@@ -34,18 +33,18 @@ void main() {
 
     group('constructor', () {
       test('generates id when not provided', () {
-        final ad = createSubject();
+        final ad = createSubject(action: defaultAction);
         expect(ad.id, isA<String>());
         expect(Uuid.isValidUUID(fromString: ad.id), isTrue);
       });
 
       test('uses provided id', () {
-        final ad = createSubject(id: testId);
+        final ad = createSubject(id: testId, action: defaultAction);
         expect(ad.id, testId);
       });
 
       test('initializes all properties correctly', () {
-        final ad = createSubject();
+        final ad = createSubject(action: defaultAction);
         expect(ad.imageUrl, testImageUrl);
         expect(ad.targetUrl, testTargetUrl);
         expect(ad.adType, testAdType);
@@ -59,12 +58,12 @@ void main() {
       test('returns a new instance with updated fields', () {
         const newImageUrl = 'http://new.com/ad.png';
         const newAdType = AdType.video;
-        const newAction = OpenInternalContent(
+        final newAction = OpenInternalContent(
           contentId: 'new-content',
           contentType: ContentType.headline,
         );
 
-        final originalAd = createSubject();
+        final originalAd = createSubject(action: defaultAction);
         final updatedAd = originalAd.copyWith(
           imageUrl: newImageUrl,
           adType: newAdType,
@@ -81,7 +80,7 @@ void main() {
       });
 
       test('returns an identical copy if no updates provided', () {
-        final originalAd = createSubject();
+        final originalAd = createSubject(action: defaultAction);
         final copiedAd = originalAd.copyWith();
         expect(copiedAd, originalAd);
         expect(identical(copiedAd, originalAd), isFalse);
@@ -90,7 +89,7 @@ void main() {
 
     group('toJson', () {
       test('serializes full Ad object to JSON', () {
-        final ad = createSubject();
+        final ad = createSubject(action: defaultAction);
         final json = ad.toJson();
 
         expect(json, <String, dynamic>{
@@ -105,7 +104,7 @@ void main() {
       });
 
       test('omits null optional fields from JSON', () {
-        final ad = createSubject(placement: null);
+        final ad = createSubject(placement: null, action: defaultAction);
         final json = ad.toJson();
 
         expect(json.containsKey('placement'), isFalse);
@@ -164,19 +163,19 @@ void main() {
 
     group('Equatable', () {
       test('instances with same properties are equal', () {
-        final ad1 = createSubject(id: '1');
-        final ad2 = createSubject(id: '1');
+        final ad1 = createSubject(id: '1', action: defaultAction);
+        final ad2 = createSubject(id: '1', action: defaultAction);
         expect(ad1, ad2);
       });
 
       test('instances with different properties are not equal', () {
-        final ad1 = createSubject(id: '1');
-        final ad2 = createSubject(id: '2');
+        final ad1 = createSubject(id: '1', action: defaultAction);
+        final ad2 = createSubject(id: '2', action: defaultAction);
         expect(ad1, isNot(equals(ad2)));
       });
 
       test('props list contains all relevant fields', () {
-        final ad = createSubject();
+        final ad = createSubject(action: defaultAction);
         expect(ad.props, [
           ad.id,
           ad.imageUrl,

test/src/models/feed/engagement_content_test.dart

@@ -13,16 +13,15 @@ void main() {
     const testEngagementContentType = EngagementContentType.signUp;
     const testCallToActionText = 'Sign Up Now!';
     const testCallToActionUrl = 'http://example.com/signup';
-    const defaultAction = OpenExternalUrl(url: 'http://default.com');
+    final defaultAction = OpenExternalUrl(url: 'http://default.com');
 
     EngagementContent createSubject({
-      String? id,
+      required FeedItemAction action, String? id,
       String title = testTitle,
       String? description = testDescription,
       EngagementContentType engagementContentType = testEngagementContentType,
       String? callToActionText = testCallToActionText,
       String? callToActionUrl = testCallToActionUrl,
-      FeedItemAction action = defaultAction,
     }) {
       return EngagementContent(
         id: id,
@@ -37,18 +36,18 @@ void main() {
 
     group('constructor', () {
       test('generates id when not provided', () {
-        final content = createSubject();
+        final content = createSubject(action: defaultAction);
         expect(content.id, isA<String>());
         expect(Uuid.isValidUUID(fromString: content.id), isTrue);
       });
 
       test('uses provided id', () {
-        final content = createSubject(id: testId);
+        final content = createSubject(id: testId, action: defaultAction);
         expect(content.id, testId);
       });
 
       test('initializes all properties correctly', () {
-        final content = createSubject();
+        final content = createSubject(action: defaultAction);
         expect(content.title, testTitle);
         expect(content.description, testDescription);
         expect(content.engagementContentType, testEngagementContentType);
@@ -66,12 +65,12 @@ void main() {
         const newEngagementContentType = EngagementContentType.feedback;
         const newCallToActionText = 'Give Feedback';
         const newCallToActionUrl = 'http://example.com/feedback';
-        const newAction = OpenInternalContent(
+        final newAction = OpenInternalContent(
           contentId: 'feedback-id',
           contentType: ContentType.category,
         );
 
-        final originalContent = createSubject();
+        final originalContent = createSubject(action: defaultAction);
         final updatedContent = originalContent.copyWith(
           title: newTitle,
           description: newDescription,
@@ -92,7 +91,7 @@ void main() {
       });
 
       test('returns an identical copy if no updates provided', () {
-        final originalContent = createSubject();
+        final originalContent = createSubject(action: defaultAction);
         final copiedContent = originalContent.copyWith();
         expect(copiedContent, originalContent);
         expect(identical(copiedContent, originalContent), isFalse);
@@ -101,7 +100,7 @@ void main() {
 
     group('toJson', () {
       test('serializes full EngagementContent object to JSON', () {
-        final content = createSubject();
+        final content = createSubject(action: defaultAction);
         final json = content.toJson();
 
         expect(json, <String, dynamic>{
@@ -121,6 +120,7 @@ void main() {
           description: null,
           callToActionText: null,
           callToActionUrl: null,
+          action: defaultAction,
         );
         final json = content.toJson();
 
@@ -185,19 +185,19 @@ void main() {
 
     group('Equatable', () {
       test('instances with same properties are equal', () {
-        final content1 = createSubject(id: '1');
-        final content2 = createSubject(id: '1');
+        final content1 = createSubject(id: '1', action: defaultAction);
+        final content2 = createSubject(id: '1', action: defaultAction);
         expect(content1, content2);
       });
 
       test('instances with different properties are not equal', () {
-        final content1 = createSubject(id: '1');
-        final content2 = createSubject(id: '2');
+        final content1 = createSubject(id: '1', action: defaultAction);
+        final content2 = createSubject(id: '2', action: defaultAction);
         expect(content1, isNot(equals(content2)));
       });
 
       test('props list contains all relevant fields', () {
-        final content = createSubject();
+        final content = createSubject(action: defaultAction);
         expect(content.props, [
           content.id,
           content.title,