feat: add app settings models

- Added DisplaySettings model
- Added supporting enums
- Added JSON serialization
- Added unit tests

Author: fulleni

README.md

@@ -1,6 +1,6 @@
 # ht_shared
 
-![coverage: percentage](https://img.shields.io/badge/coverage-96-green)
+![coverage: percentage](https://img.shields.io/badge/coverage-97-green)
 [![style: very good analysis](https://img.shields.io/badge/style-very_good_analysis-B22C89.svg)](https://pub.dev/packages/very_good_analysis)
 [![License: PolyForm Free Trial](https://img.shields.io/badge/License-PolyForm%20Free%20Trial-blue)](https://polyformproject.org/licenses/free-trial/1.0.0)
 

lib/src/models/app-settings/app_accent_theme.dart

@@ -0,0 +1,20 @@
+/// {@template app_accent_theme}
+/// Represents a selection of predefined accent color themes.
+///
+/// These themes typically define the primary accent color used for interactive
+/// elements, highlights, and branding touches throughout the application.
+/// The actual `ColorScheme` associated with each enum value would be defined
+/// within the application's theme configuration.
+/// {@endtemplate}
+enum AppAccentTheme {
+  /// The default blue accent theme.
+  defaultBlue,
+
+  /// A red accent theme, often suitable for news applications.
+  newsRed,
+
+  /// A neutral gray/graphite accent theme.
+  graphiteGray,
+
+  // Add other predefined accent themes here as needed.
+}

lib/src/models/app-settings/app_base_theme.dart

@@ -0,0 +1,16 @@
+/// {@template app_base_theme}
+/// Represents the available base application theme modes.
+///
+/// This determines the overall light or dark appearance of the UI,
+/// or allows following the device's system setting.
+/// {@endtemplate}
+enum AppBaseTheme {
+  /// Apply the light theme.
+  light,
+
+  /// Apply the dark theme.
+  dark,
+
+  /// Follow the operating system's theme setting (light or dark).
+  system,
+}

lib/src/models/app-settings/app_font_weight.dart

@@ -0,0 +1,18 @@
+/// {@template app_font_weight}
+/// Represents user-selectable font weight preferences.
+///
+/// This allows users to choose the thickness of text characters, which can
+/// affect readability and visual style. These typically map to standard
+/// `FontWeight` values (e.g., `FontWeight.w300`, `FontWeight.w400`,
+/// `FontWeight.w700`).
+/// {@endtemplate}
+enum AppFontWeight {
+  /// Light font weight (e.g., maps to `FontWeight.w300`).
+  light,
+
+  /// Regular font weight (e.g., maps to `FontWeight.w400`).
+  regular,
+
+  /// Bold font weight (e.g., maps to `FontWeight.w700`).
+  bold,
+}

lib/src/models/app-settings/app_language.dart

@@ -0,0 +1,8 @@
+/// {@template app_language}
+/// Represents the selected application language.
+///
+/// Typically stored as an ISO 639-1 language code (e.g., 'en', 'ar').
+/// The application using this client is responsible for knowing which
+/// language codes it supports and how to map them to localized resources.
+/// {@endtemplate}
+typedef AppLanguage = String;

lib/src/models/app-settings/app_settings.dart

@@ -0,0 +1,6 @@
+export 'app_accent_theme.dart';
+export 'app_base_theme.dart';
+export 'app_font_weight.dart';
+export 'app_language.dart';
+export 'app_text_scale_factor.dart';
+export 'display_settings.dart';

lib/src/models/app-settings/app_text_scale_factor.dart

@@ -0,0 +1,20 @@
+/// {@template app_text_scale_factor}
+/// Represents user-selectable text size preferences, often mapped to
+/// system text scale factors for accessibility.
+///
+/// This allows users to increase or decrease the overall size of text
+/// throughout the application for better readability.
+/// {@endtemplate}
+enum AppTextScaleFactor {
+  /// Smaller text size.
+  small,
+
+  /// Default/medium text size.
+  medium,
+
+  /// Larger text size.
+  large,
+
+  /// Extra large text size.
+  extraLarge,
+}

lib/src/models/app-settings/display_settings.dart

@@ -0,0 +1,88 @@
+import 'package:equatable/equatable.dart';
+import 'package:ht_shared/src/models/app-settings/app_settings.dart';
+
+import 'package:json_annotation/json_annotation.dart';
+
+part 'display_settings.g.dart';
+
+/// {@template display_settings}
+/// Represents a collection of user-configurable settings related to the
+/// application's visual appearance and display characteristics.
+///
+/// This model groups settings like theme mode, accent colors, font choices,
+/// text scaling, and font weight, allowing them to be managed and persisted
+/// together.
+/// {@endtemplate}
+@JsonSerializable()
+class DisplaySettings extends Equatable {
+  /// {@macro display_settings}
+  ///
+  /// Creates a new instance of [DisplaySettings].
+  ///
+  /// Provides sensible defaults for each setting if not specified:
+  /// - `baseTheme`: [AppBaseTheme.system]
+  /// - `accentTheme`: [AppAccentTheme.defaultBlue]
+  /// - `fontFamily`: 'SystemDefault' (indicating usage of the platform's
+  ///   default font)
+  /// - `textScaleFactor`: [AppTextScaleFactor.medium]
+  /// - `fontWeight`: [AppFontWeight.regular]
+  const DisplaySettings({
+    this.baseTheme = AppBaseTheme.system, // Default value
+    this.accentTheme = AppAccentTheme.defaultBlue, // Default value
+    this.fontFamily = 'SystemDefault', // Default value
+    this.textScaleFactor = AppTextScaleFactor.medium, // Default value
+    this.fontWeight = AppFontWeight.regular, // Default value
+  });
+
+  /// Creates a [DisplaySettings] instance from a JSON map.
+  factory DisplaySettings.fromJson(Map<String, dynamic> json) =>
+      _$DisplaySettingsFromJson(json);
+
+  /// The base theme mode (light, dark, or system default).
+  final AppBaseTheme baseTheme;
+
+  /// The selected predefined accent color theme.
+  final AppAccentTheme accentTheme;
+
+  /// The name or identifier of the selected font family.
+  /// 'SystemDefault' is used as a convention to indicate the platform's
+  /// default font should be used. Other values would correspond to specific
+  /// font families bundled with or available to the application.
+  final String fontFamily;
+
+  /// The preferred text size scaling factor.
+  final AppTextScaleFactor textScaleFactor;
+
+  /// The preferred font weight.
+  final AppFontWeight fontWeight;
+
+  /// Creates a copy of this [DisplaySettings] but with the given fields
+  /// replaced with the new values.
+  DisplaySettings copyWith({
+    AppBaseTheme? baseTheme,
+    AppAccentTheme? accentTheme,
+    String? fontFamily,
+    AppTextScaleFactor? textScaleFactor,
+    AppFontWeight? fontWeight,
+  }) {
+    return DisplaySettings(
+      baseTheme: baseTheme ?? this.baseTheme,
+      accentTheme: accentTheme ?? this.accentTheme,
+      fontFamily: fontFamily ?? this.fontFamily,
+      textScaleFactor: textScaleFactor ?? this.textScaleFactor,
+      fontWeight: fontWeight ?? this.fontWeight,
+    );
+  }
+
+  @override
+  List<Object?> get props => [
+    baseTheme,
+    accentTheme,
+    fontFamily,
+    textScaleFactor,
+    fontWeight,
+  ];
+
+  /// Converts this [DisplaySettings] instance to a JSON map.
+  Map<String, dynamic> toJson() => _$DisplaySettingsToJson(this);
+}

lib/src/models/app-settings/display_settings.g.dart

@@ -1,8 +1,10 @@
+export 'app-settings/app_settings.dart';
 export 'auth_success_response.dart';
 export 'category.dart';
 export 'country.dart';
 export 'headline.dart';
 export 'paginated_reponse.dart';
+export 'permission.dart';
 export 'response_metadata.dart';
 export 'source.dart';
 export 'success_api_response.dart';