feat: add permission/user/group models, start integration into code

packages/paperless_api/lib/src/models/user_model.dart

@@ -0,0 +1,72 @@
+// ignore_for_file: invalid_annotation_target
+
+import 'package:freezed_annotation/freezed_annotation.dart';
+import 'package:hive/hive.dart';
+import 'package:paperless_api/config/hive/hive_type_ids.dart';
+import 'package:paperless_api/src/models/permissions/inherited_permissions.dart';
+import 'package:paperless_api/src/models/permissions/user_permissions.dart';
+
+part 'user_model.freezed.dart';
+part 'user_model.g.dart';
+
+@freezed
+class UserModel with _$UserModel {
+  const UserModel._();
+
+  @JsonSerializable(fieldRename: FieldRename.snake)
+  @HiveType(typeId: PaperlessApiHiveTypeIds.userModelv3)
+  const factory UserModel.v3({
+    @HiveField(0) required int id,
+    @HiveField(1) required String username,
+    @HiveField(2) required String email,
+    @HiveField(3) String? firstName,
+    @HiveField(4) String? lastName,
+    @HiveField(5) DateTime? dateJoined,
+    @HiveField(6) @Default(true) bool isStaff,
+    @HiveField(7) @Default(true) bool isActive,
+    @HiveField(8) @Default(true) bool isSuperuser,
+    @HiveField(9) @Default([]) List<int> groups,
+    @HiveField(10) @Default(UserPermissions.values) List<UserPermissions> userPermissions,
+    @HiveField(11)
+    @Default(InheritedPermissions.values)
+        List<InheritedPermissions> inheritedPermissions,
+  }) = UserModelV3;
+
+  @JsonSerializable(fieldRename: FieldRename.snake)
+  @HiveType(typeId: PaperlessApiHiveTypeIds.userModelv2)
+  const factory UserModel.v2({
+    @HiveField(0) @JsonKey(name: "user_id") required int id,
+    @HiveField(1) required String username,
+    @HiveField(2) String? displayName,
+  }) = UserModelV2;
+
+  factory UserModel.fromJson(Map<String, dynamic> json) => _$UserModelFromJson(json);
+
+  String? get fullName => map(
+        v2: (value) => value.displayName,
+        v3: (value) {
+          if (value.firstName == null && value.lastName == null) {
+            return null;
+          }
+          if (value.firstName == null) {
+            return value.lastName;
+          }
+          return value.firstName! + (value.lastName ?? '');
+        },
+      );
+
+  bool hasPermission(UserPermissions permission) {
+    return map(
+      v3: (value) {
+        if (value.isSuperuser) {
+          return true;
+        }
+        return value.userPermissions.contains(permission);
+      },
+      v2: (value) {
+        // In previous versions, all users have access to all
+        return true;
+      },
+    );
+  }
+}