feat: add isAdmin field to User model

- Added isAdmin field to User model
- Updated User model documentation
- Updated tests for the new field

Author: fulleni

README.md

@@ -27,7 +27,7 @@ This package provides the following core data models:
 *   **`Category`**: Represents a news category with an ID, name, and optional description and icon URL.
 *   **`Source`**: Represents a news source, including ID, name, description, URL, language, optional headquarters (`Country`), and a `SourceType` enum (e.g., `newsAgency`, `blog`).
 *   **`Country`**: Represents a country with an ID, ISO code, name, and flag URL.
-*   **`User`**: Represents an authenticated user within the system.
+*   **`User`**: Represents an authenticated user within the system, including an `isAdmin` flag.
 *   **`PaginatedResponse<T>`**: A generic class for handling paginated API responses, containing a list of items (`items`), a `cursor` for the next page, and a `hasMore` flag.
 *   **`AuthSuccessResponse`**: Represents the successful result of an authentication operation, typically containing the authenticated user details and an access token.
 *   **`SuccessApiResponse<T>`**: A generic wrapper for successful API responses, containing the main `data` payload (of type `T`) and optional `ResponseMetadata`.

lib/src/models/user.dart

@@ -7,15 +7,21 @@ part 'user.g.dart';
 ///
 /// This model holds basic information about the user, including their
 /// unique identifier, email (if available), and whether they are
-/// authenticated anonymously.
+/// authenticated anonymously. It also includes an [isAdmin] flag
+/// to indicate administrative privileges.
 @JsonSerializable()
 class User extends Equatable {
   /// Creates a new [User] instance.
   ///
-  /// Requires a unique [id] and an [isAnonymous] flag.
+  /// Requires a unique [id], an [isAnonymous] flag, and an [isAdmin] flag.
   /// The [email] is optional and typically present only for non-anonymous
   /// users who have verified their email address.
-  const User({required this.id, required this.isAnonymous, this.email});
+  const User({
+    required this.id,
+    required this.isAnonymous,
+    required this.isAdmin,
+    this.email,
+  });
 
   /// Creates a User from JSON data.
   factory User.fromJson(Map<String, dynamic> json) => _$UserFromJson(json);
@@ -35,14 +41,17 @@ class User extends Equatable {
   /// `false` otherwise.
   final bool isAnonymous;
 
+  /// Indicates whether the user has administrative privileges.
+  final bool isAdmin;
+
   /// Converts this User instance to JSON data.
   Map<String, dynamic> toJson() => _$UserToJson(this);
 
   @override
-  List<Object?> get props => [id, email, isAnonymous];
+  List<Object?> get props => [id, email, isAnonymous, isAdmin];
 
   @override
   String toString() {
-    return 'User(id: $id, email: $email, isAnonymous: $isAnonymous)';
+    return 'User(id: $id, email: $email, isAnonymous: $isAnonymous, isAdmin: $isAdmin)';
   }
 }

lib/src/models/user.g.dart

@@ -8,6 +8,7 @@ void main() {
       id: 'user-123',
       email: 'test@example.com',
       isAnonymous: false,
+      isAdmin: false,
     );
     const testToken = 'sample-jwt-token';
 
@@ -95,6 +96,7 @@ void main() {
           id: 'user-456',
           email: 'updated@example.com',
           isAnonymous: true,
+          isAdmin: false,
         );
         final copiedResponse = authSuccessResponse.copyWith(user: updatedUser);
 
@@ -115,7 +117,7 @@ void main() {
       });
 
       test('should create a copy with both user and token updated', () {
-        const updatedUser = User(id: 'user-789', isAnonymous: true);
+        const updatedUser = User(id: 'user-789', isAnonymous: true, isAdmin: false);
         const updatedToken = 'another-token-xyz';
         final copiedResponse = authSuccessResponse.copyWith(
           user: updatedUser,
@@ -137,7 +139,7 @@ void main() {
       });
 
       test('should not equate instances with different users', () {
-        const differentUser = User(id: 'diff-user', isAnonymous: false);
+        const differentUser = User(id: 'diff-user', isAnonymous: false, isAdmin: false);
         const response1 = AuthSuccessResponse(user: testUser, token: testToken);
         const response2 = AuthSuccessResponse(
           user: differentUser,

test/src/models/auth_success_response_test.dart

@@ -8,51 +8,103 @@ void main() {
 
     test('supports value equality', () {
       expect(
-        const User(id: id, email: email, isAnonymous: false),
-        equals(const User(id: id, email: email, isAnonymous: false)),
+        const User(id: id, email: email, isAnonymous: false, isAdmin: false),
+        equals(
+          const User(id: id, email: email, isAnonymous: false, isAdmin: false),
+        ),
       );
       expect(
-        const User(id: id, email: email, isAnonymous: false),
+        const User(id: id, email: email, isAnonymous: false, isAdmin: false),
         isNot(
-          equals(const User(id: 'other-id', email: email, isAnonymous: false)),
+          equals(
+            const User(
+              id: 'other-id',
+              email: email,
+              isAnonymous: false,
+              isAdmin: false,
+            ),
+          ),
         ),
       );
       expect(
-        const User(id: id, email: email, isAnonymous: false),
+        const User(id: id, email: email, isAnonymous: false, isAdmin: false),
         isNot(
           equals(
-            const User(id: id, email: 'other@example.com', isAnonymous: false),
+            const User(
+              id: id,
+              email: 'other@example.com',
+              isAnonymous: false,
+              isAdmin: false,
+            ),
           ),
         ),
       );
       expect(
-        const User(id: id, email: email, isAnonymous: false),
-        isNot(equals(const User(id: id, email: email, isAnonymous: true))),
+        const User(id: id, email: email, isAnonymous: false, isAdmin: false),
+        isNot(
+          equals(
+            const User(id: id, email: email, isAnonymous: true, isAdmin: false),
+          ),
+        ),
+      );
+      expect(
+        const User(id: id, email: email, isAnonymous: false, isAdmin: false),
+        isNot(
+          equals(
+            const User(id: id, email: email, isAnonymous: false, isAdmin: true),
+          ),
+        ),
       );
     });
 
     test('has correct toString', () {
       expect(
-        const User(id: id, email: email, isAnonymous: false).toString(),
-        equals('User(id: $id, email: $email, isAnonymous: false)'),
+        const User(
+          id: id,
+          email: email,
+          isAnonymous: false,
+          isAdmin: false,
+        ).toString(),
+        equals(
+          'User(id: $id, email: $email, isAnonymous: false, isAdmin: false)',
+        ),
       );
       expect(
-        const User(id: id, isAnonymous: true).toString(),
-        equals('User(id: $id, email: null, isAnonymous: true)'),
+        const User(id: id, isAnonymous: true, isAdmin: false).toString(),
+        equals('User(id: $id, email: null, isAnonymous: true, isAdmin: false)'),
+      );
+      expect(
+        const User(id: id, isAnonymous: false, isAdmin: true).toString(),
+        equals('User(id: $id, email: null, isAnonymous: false, isAdmin: true)'),
       );
     });
 
     // Basic test for JSON serialization - assumes build_runner generated correctly
     test('can be serialized and deserialized', () {
-      const user = User(id: id, email: email, isAnonymous: false);
+      const user = User(
+        id: id,
+        email: email,
+        isAnonymous: false,
+        isAdmin: false,
+      );
       final json = user.toJson();
       final deserializedUser = User.fromJson(json);
       expect(deserializedUser, equals(user));
 
-      const anonUser = User(id: id, isAnonymous: true);
+      const anonUser = User(id: id, isAnonymous: true, isAdmin: false);
       final anonJson = anonUser.toJson();
       final deserializedAnonUser = User.fromJson(anonJson);
       expect(deserializedAnonUser, equals(anonUser));
+
+      const adminUser = User(
+        id: id,
+        email: email,
+        isAnonymous: false,
+        isAdmin: true,
+      );
+      final adminJson = adminUser.toJson();
+      final deserializedAdminUser = User.fromJson(adminJson);
+      expect(deserializedAdminUser, equals(adminUser));
     });
   });
 }