refactor: update @JsonSerializable() Annotations on Classes @ Added @jsonkey(unknownEnumValue: ...) to Enum Fields

Author: fulleni

lib/src/models/auth/permission.dart

@@ -1,5 +1,6 @@
 import 'package:equatable/equatable.dart';
 import 'package:json_annotation/json_annotation.dart';
+import 'package:meta/meta.dart';
 
 part 'permission.g.dart';
 
@@ -8,7 +9,14 @@ part 'permission.g.dart';
 ///
 /// Permissions follow the format `resource.action`.
 /// {@endtemplate}
-@JsonSerializable()
+
+@immutable
+@JsonSerializable(
+  fieldRename: FieldRename.snake,
+  explicitToJson: true,
+  includeIfNull: false,
+  checked: true,
+)
 class Permission extends Equatable {
   /// {@macro permission}
   const Permission({required this.name});

lib/src/models/auth/user.dart

@@ -1,14 +1,22 @@
 import 'package:equatable/equatable.dart';
 import 'package:ht_shared/src/models/auth/user_role.dart';
 import 'package:json_annotation/json_annotation.dart';
+import 'package:meta/meta.dart';
 
 part 'user.g.dart';
 
 /// Represents a user within the system.
 ///
 /// This model holds basic information about the user, including their
 /// unique identifier, email (if available), and their assigned [role].
-@JsonSerializable()
+
+@immutable
+@JsonSerializable(
+  fieldRename: FieldRename.snake,
+  explicitToJson: true,
+  includeIfNull: false,
+  checked: true,
+)
 class User extends Equatable {
   /// Creates a new [User] instance.
   ///
@@ -34,6 +42,7 @@ class User extends Equatable {
   final String? email;
 
   /// The role of the user.
+  @JsonKey(unknownEnumValue: JsonKey.nullForUndefinedEnumValue)
   final UserRole role;
 
   /// The date and time the user account was created.

lib/src/models/core/feed_item_action.dart

@@ -1,10 +1,7 @@
 import 'package:equatable/equatable.dart';
-import 'package:ht_shared/ht_shared.dart' show FeedItem;
 import 'package:ht_shared/src/models/core/content_type.dart';
-import 'package:ht_shared/src/models/core/feed_item.dart' show FeedItem;
-import 'package:ht_shared/src/models/models.dart' show FeedItem;
-// Removed redundant FeedItem imports
 import 'package:json_annotation/json_annotation.dart';
+import 'package:meta/meta.dart';
 
 part 'feed_item_action.g.dart';
 
@@ -15,7 +12,14 @@ part 'feed_item_action.g.dart';
 /// and defined within this library. This allows for exhaustive pattern
 /// matching in the UI layer.
 /// {@endtemplate}
-@JsonSerializable(createFactory: false)
+@immutable
+@JsonSerializable(
+  createFactory: false,
+  fieldRename: FieldRename.snake,
+  explicitToJson: true,
+  includeIfNull: false,
+  checked: true,
+)
 sealed class FeedItemAction extends Equatable {
   /// {@macro feed_item_action}
   const FeedItemAction({required this.type});
@@ -66,7 +70,13 @@ Map<String, dynamic> feedItemActionToJson(FeedItemAction action) {
 /// {@template open_internal_content}
 /// An action to open content that resides within the application.
 /// {@endtemplate}
-@JsonSerializable()
+@immutable
+@JsonSerializable(
+  fieldRename: FieldRename.snake,
+  explicitToJson: true,
+  includeIfNull: false,
+  checked: true,
+)
 class OpenInternalContent extends FeedItemAction {
   /// {@macro open_internal_content}
   const OpenInternalContent({
@@ -82,6 +92,7 @@ class OpenInternalContent extends FeedItemAction {
   final String contentId;
 
   /// The type of the internal content (e.g., headline, category, source).
+  @JsonKey(unknownEnumValue: JsonKey.nullForUndefinedEnumValue)
   final ContentType contentType;
 
   @override
@@ -99,7 +110,13 @@ class OpenInternalContent extends FeedItemAction {
 /// {@template show_interstitial_then_open_internal_content}
 /// An action to show an interstitial advertisement, then open internal content.
 /// {@endtemplate}
-@JsonSerializable()
+@immutable
+@JsonSerializable(
+  fieldRename: FieldRename.snake,
+  explicitToJson: true,
+  includeIfNull: false,
+  checked: true,
+)
 class ShowInterstitialThenOpenInternalContent extends FeedItemAction {
   /// {@macro show_interstitial_then_open_internal_content}
   const ShowInterstitialThenOpenInternalContent({
@@ -118,6 +135,7 @@ class ShowInterstitialThenOpenInternalContent extends FeedItemAction {
   final String contentId;
 
   /// The type of the internal content (e.g., headline, category, source).
+  @JsonKey(unknownEnumValue: JsonKey.nullForUndefinedEnumValue)
   final ContentType contentType;
 
   @override
@@ -134,7 +152,13 @@ class ShowInterstitialThenOpenInternalContent extends FeedItemAction {
 /// {@template open_external_url}
 /// An action to open an external URL, typically in a web browser.
 /// {@endtemplate}
-@JsonSerializable()
+@immutable
+@JsonSerializable(
+  fieldRename: FieldRename.snake,
+  explicitToJson: true,
+  includeIfNull: false,
+  checked: true,
+)
 class OpenExternalUrl extends FeedItemAction {
   /// {@macro open_external_url}
   const OpenExternalUrl({required this.url}) : super(type: 'open_external_url');

lib/src/models/entities/category.dart

@@ -14,7 +14,12 @@ part 'category.g.dart';
 /// The [id] is automatically generated using UUID v4 if not provided.
 /// {@endtemplate}
 @immutable
-@JsonSerializable(explicitToJson: true, includeIfNull: false)
+@JsonSerializable(
+  fieldRename: FieldRename.snake,
+  explicitToJson: true,
+  includeIfNull: false,
+  checked: true,
+)
 class Category extends FeedItem {
   /// {@macro category}
   ///

lib/src/models/entities/country.dart

@@ -2,6 +2,7 @@ import 'package:ht_shared/src/models/core/feed_item.dart';
 import 'package:ht_shared/src/models/core/feed_item_action.dart'
     show FeedItemAction, feedItemActionFromJson, feedItemActionToJson;
 import 'package:json_annotation/json_annotation.dart';
+import 'package:meta/meta.dart';
 import 'package:uuid/uuid.dart';
 
 part 'country.g.dart';
@@ -12,7 +13,13 @@ part 'country.g.dart';
 /// Used typically in contexts like selecting a country for news headlines
 /// or user profile settings.
 /// {@endtemplate}
-@JsonSerializable()
+@immutable
+@JsonSerializable(
+  fieldRename: FieldRename.snake,
+  explicitToJson: true,
+  includeIfNull: false,
+  checked: true,
+)
 class Country extends FeedItem {
   /// {@macro country}
   Country({

lib/src/models/entities/headline.dart

@@ -21,7 +21,12 @@ DateTime? _dateTimeFromJson(String? dateString) {
 /// Represents a news headline item.
 /// {@endtemplate}
 @immutable
-@JsonSerializable(explicitToJson: true, includeIfNull: false)
+@JsonSerializable(
+  fieldRename: FieldRename.snake,
+  explicitToJson: true,
+  includeIfNull: false,
+  checked: true,
+)
 class Headline extends FeedItem {
   /// {@macro headline}
   Headline({
@@ -42,7 +47,7 @@ class Headline extends FeedItem {
         action = action,
         super(type: 'headline', action: action);
 
-  /// Factory method to create a [Headline] instance from a JSON map.
+  /// Creates a [Headline] instance from a JSON map.
   factory Headline.fromJson(Map<String, dynamic> json) =>
       _$HeadlineFromJson(json);
 
@@ -59,11 +64,9 @@ class Headline extends FeedItem {
   final String? url;
 
   /// URL to an image associated with the headline.
-  @JsonKey(name: 'imageUrl')
   final String? imageUrl;
 
   /// Date and time when the headline was published.
-  @JsonKey(name: 'publishedAt', fromJson: _dateTimeFromJson)
   final DateTime? publishedAt;
 
   /// Source or origin of the headline.

lib/src/models/entities/source.dart

@@ -4,6 +4,7 @@ import 'package:ht_shared/src/models/core/feed_item_action.dart'
 import 'package:ht_shared/src/models/entities/country.dart';
 import 'package:ht_shared/src/models/entities/source_type.dart';
 import 'package:json_annotation/json_annotation.dart';
+import 'package:meta/meta.dart';
 import 'package:uuid/uuid.dart';
 
 part 'source.g.dart';
@@ -13,20 +14,25 @@ part 'source.g.dart';
 ///
 /// Represents a news source.
 /// {@endtemplate}
-@JsonSerializable(explicitToJson: true, includeIfNull: false)
+@immutable
+@JsonSerializable(
+  fieldRename: FieldRename.snake,
+  explicitToJson: true,
+  includeIfNull: false,
+  checked: true,
+)
 class Source extends FeedItem {
   /// {@macro source}
   Source({
     required this.name,
     required this.action,
     this.description,
     this.url,
-    this.sourceType, // Changed from _sourceType
+    this.sourceType,
     this.language,
     this.headquarters,
     String? id,
   })  : id = id ?? const Uuid().v4(),
-        // _sourceType assignment removed, directly using this.sourceType
         super(type: 'source', action: action);
 
   /// Factory method to create a [Source] instance from a JSON map.
@@ -48,11 +54,8 @@ class Source extends FeedItem {
   /// The type of the source (e.g., newsAgency, blog).
   /// If an unknown value is encountered during deserialization,
   /// this field will be set to null.
-  @JsonKey(
-    // name: 'sourceType' removed as field name now matches JSON key
-    unknownEnumValue: JsonKey.nullForUndefinedEnumValue,
-  )
-  final SourceType? sourceType; // Field renamed to public
+  @JsonKey(unknownEnumValue: JsonKey.nullForUndefinedEnumValue)
+  final SourceType? sourceType;
 
   /// The language code of the source (e.g., 'en', 'fr').
   final String? language;

lib/src/models/entities/source_type.dart

@@ -1,7 +1,7 @@
 import 'package:json_annotation/json_annotation.dart';
 
 /// Enum representing the type of news source.
-@JsonEnum(fieldRename: FieldRename.kebab)
+@JsonEnum(fieldRename: FieldRename.snake)
 enum SourceType {
   /// A global news agency
   /// (e.g., Reuters, Associated Press, Agence France-Presse).

lib/src/models/feed_decorators/ad.dart

@@ -3,6 +3,7 @@ import 'package:ht_shared/src/models/core/feed_item_action.dart'
     show FeedItemAction, feedItemActionFromJson, feedItemActionToJson;
 import 'package:ht_shared/src/models/feed_decorators/ad_placement.dart';
 import 'package:json_annotation/json_annotation.dart';
+import 'package:meta/meta.dart';
 import 'package:uuid/uuid.dart';
 
 part 'ad.g.dart';
@@ -28,7 +29,13 @@ enum AdType {
 /// {@template ad}
 /// Represents an advertisement item that can appear in the feed.
 /// {@endtemplate}
-@JsonSerializable(explicitToJson: true, includeIfNull: false)
+@immutable
+@JsonSerializable(
+  fieldRename: FieldRename.snake,
+  explicitToJson: true,
+  includeIfNull: false,
+  checked: true,
+)
 class Ad extends FeedItem {
   /// {@macro ad}
   Ad({

lib/src/models/feed_decorators/engagement_content.dart

@@ -3,6 +3,7 @@ import 'package:ht_shared/src/models/core/feed_item_action.dart'
     show FeedItemAction, feedItemActionFromJson, feedItemActionToJson;
 import 'package:ht_shared/src/models/feed_decorators/engagement_content_type.dart';
 import 'package:json_annotation/json_annotation.dart';
+import 'package:meta/meta.dart';
 import 'package:uuid/uuid.dart';
 
 part 'engagement_content.g.dart';
@@ -14,7 +15,13 @@ part 'engagement_content.g.dart';
 /// or providing feedback. The [engagementContentType] specifies the nature
 /// of the call-to-action.
 /// {@endtemplate}
-@JsonSerializable(explicitToJson: true, includeIfNull: false)
+@immutable
+@JsonSerializable(
+  fieldRename: FieldRename.snake,
+  explicitToJson: true,
+  includeIfNull: false,
+  checked: true,
+)
 class EngagementContent extends FeedItem {
   /// {@macro engagement_content}
   EngagementContent({
@@ -84,31 +91,21 @@ class EngagementContent extends FeedItem {
   EngagementContent copyWith({
     String? id,
     String? title,
-    Object? description = const _Sentinel(),
-    Object? engagementContentType = const _Sentinel(),
-    Object? callToActionText = const _Sentinel(),
-    Object? callToActionUrl = const _Sentinel(),
+    String? description,
+    EngagementContentType? engagementContentType,
+    String? callToActionText,
+    String? callToActionUrl,
     FeedItemAction? action,
   }) {
     return EngagementContent(
       id: id ?? this.id,
       title: title ?? this.title,
-      description:
-          description is _Sentinel ? this.description : description as String?,
-      engagementContentType: engagementContentType is _Sentinel
-          ? this.engagementContentType
-          : engagementContentType as EngagementContentType?,
-      callToActionText: callToActionText is _Sentinel
-          ? this.callToActionText
-          : callToActionText as String?,
-      callToActionUrl: callToActionUrl is _Sentinel
-          ? this.callToActionUrl
-          : callToActionUrl as String?,
+      description: description ?? this.description,
+      engagementContentType:
+          engagementContentType ?? this.engagementContentType,
+      callToActionText: callToActionText ?? this.callToActionText,
+      callToActionUrl: callToActionUrl ?? this.callToActionUrl,
       action: action ?? this.action,
     );
   }
 }
-
-class _Sentinel {
-  const _Sentinel();
-}