feat filter bookmarked entry model

CHANGELOG.md

@@ -0,0 +1,11 @@
+# 1.2.0 - 2024-05-21
+
+- feat: add SavedFilter model for storing user-defined filter combinations.
+- **BREAKING** feat!: link SavedFilter to UserContentPreferences, making `savedFilters` a required field.
+- **BREAKING** feat!: add limits for saved filters to UserPreferenceConfig.
+- **BREAKING** refactor!: organize saved models into a new `user_presets` directory.
+- test: add unit tests for SavedFilter model.
+- test: update tests for UserContentPreferences to include saved filters.
+- docs: update README to reflect new User Presets section and model.
+- chore: add fixture data for SavedFilter.
+- chore: synchronize all related fixtures with recent model updates.

README.md

@@ -27,6 +27,9 @@ This package provides the critical building blocks for a professional news appli
 - **`User`, `AppUserRole`, `DashboardUserRole`, `Permission`:** Robust models for user profiles, roles, and permissions, enabling secure and personalized experiences.
 - **`UserContentPreferences`, `UserAppSettings`:** Detailed models for storing user-specific content preferences (e.g., followed topics, saved headlines) and application settings (e.g., theme, language).
 
+### 💾 User Presets
+- **`SavedFilter`:** A model for storing user-defined filter combinations.
+
 ### ⚙️ Application Configuration
 - **`RemoteConfig`:** A central container for all dynamic application settings, fetched from a remote source. This includes:
     - **`AdConfig`:** Master configuration for all advertising, now featuring **highly flexible, role-based control** over ad visibility and frequency for feed, article, and interstitial ads. This allows for granular control over monetization strategies per user segment.

lib/src/fixtures/fixture_ids.dart

@@ -530,3 +530,7 @@ const kLocalAd3Id = '3563c000a4a4e6e1a8e7f0f3';
 const kLocalAd4Id = '4563c000a4a4e6e1a8e7f0f4';
 const kLocalAd5Id = '5563c000a4a4e6e1a8e7f0f5';
 const kLocalAd6Id = '6563c000a4a4e6e1a8e7f0f6';
+
+/// Saved filters Fixture IDs.
+const String kSavedFilterId1 = 'saved_search_1';
+const String kSavedFilterId2 = 'saved_search_2';

lib/src/fixtures/fixtures.dart

@@ -5,8 +5,9 @@ export 'headlines.dart';
 export 'languages.dart';
 export 'local_ads.dart';
 export 'remote_configs.dart';
+export 'saved_filter.dart';
 export 'sources.dart';
 export 'topics.dart';
-export 'user_app_settings_fixtures.dart';
-export 'user_content_preferences_fixtures.dart';
+export 'user_app_settings.dart';
+export 'user_content_preferences.dart';
 export 'users.dart';

lib/src/fixtures/remote_configs.dart

@@ -35,6 +35,9 @@ final List<RemoteConfig> remoteConfigsFixturesData = [
       authenticatedSavedHeadlinesLimit: 30,
       premiumFollowedItemsLimit: 30,
       premiumSavedHeadlinesLimit: 100,
+      guestSavedFiltersLimit: 3,
+      authenticatedSavedFiltersLimit: 10,
+      premiumSavedFiltersLimit: 25,
     ),
     adConfig: const AdConfig(
       enabled: true,

lib/src/fixtures/saved_filter.dart

@@ -0,0 +1,30 @@
+import 'package:core/src/fixtures/countries.dart';
+import 'package:core/src/fixtures/fixture_ids.dart';
+import 'package:core/src/fixtures/sources.dart';
+import 'package:core/src/fixtures/topics.dart';
+import 'package:core/src/models/user_presets/saved_filter.dart';
+
+/// A list of predefined saved searches for fixture data.
+final savedFiltersFixturesData = <SavedFilter>[
+  SavedFilter(
+    id: kSavedFilterId1,
+    name: 'UK Tech & Politics',
+    topics: [
+      topicsFixturesData.firstWhere((t) => t.name == 'Technology'),
+      topicsFixturesData.firstWhere((t) => t.name == 'Politics'),
+    ],
+    sources: [sourcesFixturesData.firstWhere((s) => s.name == 'BBC News')],
+    countries: [
+      countriesFixturesData.firstWhere((c) => c.name == 'United Kingdom'),
+    ],
+  ),
+  SavedFilter(
+    id: kSavedFilterId2,
+    name: 'US Business News',
+    topics: [topicsFixturesData.firstWhere((t) => t.name == 'Business')],
+    sources: const [],
+    countries: [
+      countriesFixturesData.firstWhere((c) => c.name == 'United States'),
+    ],
+  ),
+];

lib/src/fixtures/user_content_preferences_fixtures.dart → lib/src/fixtures/user_content_preferences.dart

@@ -9,5 +9,6 @@ final List<UserContentPreferences> userContentPreferencesFixturesData = [
     followedSources: [],
     followedTopics: [],
     savedHeadlines: [],
+    savedFilters: [],
   ),
 ];

lib/src/models/config/user_preference_config.dart

@@ -1,5 +1,6 @@
 import 'package:core/src/models/config/remote_config.dart';
 import 'package:core/src/models/user_preferences/user_content_preferences.dart';
+import 'package:core/src/models/user_presets/saved_filter.dart';
 import 'package:equatable/equatable.dart';
 import 'package:json_annotation/json_annotation.dart';
 import 'package:meta/meta.dart';
@@ -22,17 +23,8 @@ part 'user_preference_config.g.dart';
 ///   Countries, up to 5 Sources, and up to 5 Categories).
 /// - Saved Headlines: The limit applies to the total number of headlines
 ///   a user can save.
-///
-/// **Tiered Limits defaults:**
-/// - **Guest User:**
-///   - Followed Items (Countries, Sources, Categories): 5 each
-///   - Saved Headlines: 10
-/// - **Authenticated User:**
-///   - Followed Items (Countries, Sources, Categories): 15 each
-///   - Saved Headlines: 30
-/// - **Premium User:**
-///   - Followed Items (Countries, Sources, Categories): 30 each
-///   - Saved Headlines: 100
+/// - Saved Filters: The limit applies to the total number of [SavedFilter]
+///   a user can save.
 ///
 /// These limits are configurable to balance performance (allowing fetching
 /// full objects within these limits) and feature differentiation across tiers.
@@ -49,6 +41,9 @@ class UserPreferenceConfig extends Equatable {
     required this.authenticatedSavedHeadlinesLimit,
     required this.premiumFollowedItemsLimit,
     required this.premiumSavedHeadlinesLimit,
+    required this.guestSavedFiltersLimit,
+    required this.authenticatedSavedFiltersLimit,
+    required this.premiumSavedFiltersLimit,
   });
 
   /// Factory method to create a [UserPreferenceConfig] instance from a JSON map.
@@ -76,6 +71,15 @@ class UserPreferenceConfig extends Equatable {
   /// Maximum number of headlines a Premium user can save.
   final int premiumSavedHeadlinesLimit;
 
+  /// Maximum number of filters a Guest user can save.
+  final int guestSavedFiltersLimit;
+
+  /// Maximum number of filters an Authenticated user can save.
+  final int authenticatedSavedFiltersLimit;
+
+  /// Maximum number of filters a Premium user can save.
+  final int premiumSavedFiltersLimit;
+
   /// Converts this [UserPreferenceConfig] instance to a JSON map.
   Map<String, dynamic> toJson() => _$UserPreferenceConfigToJson(this);
 
@@ -88,6 +92,9 @@ class UserPreferenceConfig extends Equatable {
     int? authenticatedSavedHeadlinesLimit,
     int? premiumFollowedItemsLimit,
     int? premiumSavedHeadlinesLimit,
+    int? guestSavedFiltersLimit,
+    int? authenticatedSavedFiltersLimit,
+    int? premiumSavedFiltersLimit,
   }) {
     return UserPreferenceConfig(
       guestFollowedItemsLimit:
@@ -104,6 +111,12 @@ class UserPreferenceConfig extends Equatable {
           premiumFollowedItemsLimit ?? this.premiumFollowedItemsLimit,
       premiumSavedHeadlinesLimit:
           premiumSavedHeadlinesLimit ?? this.premiumSavedHeadlinesLimit,
+      guestSavedFiltersLimit:
+          guestSavedFiltersLimit ?? this.guestSavedFiltersLimit,
+      authenticatedSavedFiltersLimit:
+          authenticatedSavedFiltersLimit ?? this.authenticatedSavedFiltersLimit,
+      premiumSavedFiltersLimit:
+          premiumSavedFiltersLimit ?? this.premiumSavedFiltersLimit,
     );
   }
 
@@ -115,6 +128,9 @@ class UserPreferenceConfig extends Equatable {
     authenticatedSavedHeadlinesLimit,
     premiumFollowedItemsLimit,
     premiumSavedHeadlinesLimit,
+    guestSavedFiltersLimit,
+    authenticatedSavedFiltersLimit,
+    premiumSavedFiltersLimit,
   ];
 
   @override

lib/src/models/models.dart

@@ -8,4 +8,5 @@ export 'local_ads/local_ads.dart';
 export 'query/query.dart';
 export 'responses/responses.dart';
 export 'user_preferences/user_preferences.dart';
+export 'user_presets/user_presets.dart';
 export 'user_settings/user_settings.dart';

lib/src/models/user_preferences/user_content_preferences.dart

@@ -2,6 +2,7 @@ import 'package:core/src/models/entities/country.dart';
 import 'package:core/src/models/entities/headline.dart';
 import 'package:core/src/models/entities/source.dart';
 import 'package:core/src/models/entities/topic.dart';
+import 'package:core/src/models/user_presets/saved_filter.dart';
 import 'package:equatable/equatable.dart';
 import 'package:json_annotation/json_annotation.dart';
 import 'package:meta/meta.dart';
@@ -32,6 +33,7 @@ class UserContentPreferences extends Equatable {
     required this.followedSources,
     required this.followedTopics,
     required this.savedHeadlines,
+    required this.savedFilters,
   });
 
   /// Factory method to create a [UserContentPreferences] instance from a JSON map.
@@ -53,6 +55,9 @@ class UserContentPreferences extends Equatable {
   /// List of headlines the user has saved.
   final List<Headline> savedHeadlines;
 
+  /// List of filter combinations the user has saved.
+  final List<SavedFilter> savedFilters;
+
   /// Converts this [UserContentPreferences] instance to a JSON map.
   Map<String, dynamic> toJson() => _$UserContentPreferencesToJson(this);
 
@@ -63,6 +68,7 @@ class UserContentPreferences extends Equatable {
     followedSources,
     followedTopics,
     savedHeadlines,
+    savedFilters,
   ];
 
   @override
@@ -76,13 +82,15 @@ class UserContentPreferences extends Equatable {
     List<Source>? followedSources,
     List<Topic>? followedTopics,
     List<Headline>? savedHeadlines,
+    List<SavedFilter>? savedFilters,
   }) {
     return UserContentPreferences(
       id: id ?? this.id,
       followedCountries: followedCountries ?? this.followedCountries,
       followedSources: followedSources ?? this.followedSources,
       followedTopics: followedTopics ?? this.followedTopics,
       savedHeadlines: savedHeadlines ?? this.savedHeadlines,
+      savedFilters: savedFilters ?? this.savedFilters,
     );
   }
 }

lib/src/models/user_presets/saved_filter.dart

@@ -0,0 +1,76 @@
+import 'package:core/src/models/entities/country.dart';
+import 'package:core/src/models/entities/source.dart';
+import 'package:core/src/models/entities/topic.dart';
+import 'package:equatable/equatable.dart';
+import 'package:json_annotation/json_annotation.dart';
+import 'package:meta/meta.dart';
+
+part 'saved_filter.g.dart';
+
+/// {@template saved_filter}
+/// Represents a user-defined filter combination for filtering headlines.
+///
+/// This model stores a named set of criteria, including topics, sources, and
+/// countries, allowing users to quickly re-apply complex filters.
+/// {@endtemplate}
+@immutable
+@JsonSerializable(explicitToJson: true, includeIfNull: true, checked: true)
+class SavedFilter extends Equatable {
+  /// {@macro saved_filter}
+  const SavedFilter({
+    required this.id,
+    required this.name,
+    required this.topics,
+    required this.sources,
+    required this.countries,
+  });
+
+  /// Factory method to create a [SavedFilter] instance from a JSON map.
+  factory SavedFilter.fromJson(Map<String, dynamic> json) =>
+      _$SavedFilterFromJson(json);
+
+  /// The unique identifier for the saved filter.
+  final String id;
+
+  /// The user-provided name for this saved filter.
+  final String name;
+
+  /// The list of topics to include in the filter.
+  /// An empty list means no topic filter is applied.
+  final List<Topic> topics;
+
+  /// The list of sources to include in the filter.
+  /// An empty list means no source filter is applied.
+  final List<Source> sources;
+
+  /// The list of countries to include in the filter.
+  /// An empty list means no country filter is applied.
+  final List<Country> countries;
+
+  /// Converts this [SavedFilter] instance to a JSON map.
+  Map<String, dynamic> toJson() => _$SavedFilterToJson(this);
+
+  @override
+  List<Object?> get props => [id, name, topics, sources, countries];
+
+  @override
+  bool get stringify => true;
+
+  /// Creates a copy of this [SavedFilter] but with the given fields
+  /// replaced with the new values.
+  SavedFilter copyWith({
+    String? id,
+    String? name,
+    List<Topic>? topics,
+    List<Source>? sources,
+    List<Country>? countries,
+  }) {
+    return SavedFilter(
+      id: id ?? this.id,
+      name: name ?? this.name,
+      topics: topics ?? this.topics,
+      sources: sources ?? this.sources,
+      countries: countries ?? this.countries,
+    );
+  }
+}