Reorganized folder structure

src/HopFrame.Database/HopDbContextBase.cs

@@ -0,0 +1,32 @@
+using HopFrame.Database.Models.Entries;
+using Microsoft.EntityFrameworkCore;
+
+namespace HopFrame.Database;
+
+/// <summary>
+/// This class includes the basic database structure in order for HopFrame to work
+/// </summary>
+public abstract class HopDbContextBase : DbContext {
+
+    public virtual DbSet<UserEntry> Users { get; set; }
+    public virtual DbSet<PermissionEntry> Permissions { get; set; }
+    public virtual DbSet<TokenEntry> Tokens { get; set; }
+    public virtual DbSet<GroupEntry> Groups { get; set; }
+
+    protected override void OnModelCreating(ModelBuilder modelBuilder) {
+        base.OnModelCreating(modelBuilder);
+
+        modelBuilder.Entity<UserEntry>();
+        modelBuilder.Entity<PermissionEntry>();
+        modelBuilder.Entity<TokenEntry>();
+        modelBuilder.Entity<GroupEntry>();
+    }
+
+    /// <summary>
+    /// Gets executed when a user is deleted through the IUserService from the
+    /// HopFrame.Security package. You can override this method to also delete
+    /// related user specific entries in the database
+    /// </summary>
+    /// <param name="user"></param>
+    public virtual void OnUserDelete(UserEntry user) {}
+}

src/HopFrame.Database/HopFrame.Database.csproj

@@ -0,0 +1,20 @@
+<Project Sdk="Microsoft.NET.Sdk">
+
+    <PropertyGroup>
+        <TargetFramework>net8.0</TargetFramework>
+        <LangVersion>latest</LangVersion>
+        <ImplicitUsings>enable</ImplicitUsings>
+        <Nullable>disable</Nullable>
+        <PackageReadmeFile>README.md</PackageReadmeFile>
+        <PackageLicenseExpression>MIT</PackageLicenseExpression>
+    </PropertyGroup>
+
+    <ItemGroup>
+      <PackageReference Include="Microsoft.EntityFrameworkCore" Version="8.0.7" />
+    </ItemGroup>
+
+    <ItemGroup>
+        <None Include="README.md" Pack="true" PackagePath="\"/>
+    </ItemGroup>
+
+</Project>

src/HopFrame.Database/Models/Entries/GroupEntry.cs

@@ -0,0 +1,18 @@
+using System.ComponentModel;
+using System.ComponentModel.DataAnnotations;
+
+namespace HopFrame.Database.Models.Entries;
+
+public class GroupEntry {
+    [Key, Required, MaxLength(50)]
+    public string Name { get; set; }
+    
+    [Required, DefaultValue(false)]
+    public bool Default { get; set; }
+    
+    [MaxLength(500)]
+    public string Description { get; set; }
+    
+    [Required]
+    public DateTime CreatedAt { get; set; }
+}

src/HopFrame.Database/Models/Entries/PermissionEntry.cs

@@ -0,0 +1,18 @@
+using System.ComponentModel.DataAnnotations;
+using System.ComponentModel.DataAnnotations.Schema;
+
+namespace HopFrame.Database.Models.Entries;
+
+public sealed class PermissionEntry {
+    [Key, Required, DatabaseGenerated(DatabaseGeneratedOption.Identity)]
+    public long RecordId { get; set; }
+
+    [Required, MaxLength(255)]
+    public string PermissionText { get; set; }
+
+    [Required, MinLength(36), MaxLength(36)]
+    public string UserId { get; set; }
+
+    [Required]
+    public DateTime GrantedAt { get; set; }
+}

src/HopFrame.Database/Models/Entries/TokenEntry.cs

@@ -0,0 +1,25 @@
+using System.ComponentModel.DataAnnotations;
+
+namespace HopFrame.Database.Models.Entries;
+
+public class TokenEntry {
+    public const int RefreshTokenType = 0;
+    public const int AccessTokenType = 1;
+
+    /// <summary>
+    /// Defines the Type of the stored Token
+    /// 0: Refresh token
+    /// 1: Access token
+    /// </summary>
+    [Required, MinLength(1), MaxLength(1)]
+    public int Type { get; set; }
+
+    [Key, Required, MinLength(36), MaxLength(36)]
+    public string Token { get; set; }
+
+    [Required, MinLength(36), MaxLength(36)]
+    public string UserId { get; set; }
+
+    [Required]
+    public DateTime CreatedAt { get; set; }
+}

src/HopFrame.Database/Models/Entries/UserEntry.cs

@@ -0,0 +1,20 @@
+using System.ComponentModel.DataAnnotations;
+
+namespace HopFrame.Database.Models.Entries;
+
+public class UserEntry {
+    [Key, Required, MinLength(36), MaxLength(36)]
+    public string Id { get; set; }
+    
+    [MaxLength(50)]
+    public string Username { get; set; }
+    
+    [Required, MaxLength(50), EmailAddress]
+    public string Email { get; set; }
+    
+    [Required, MinLength(8), MaxLength(255)]
+    public string Password { get; set; }
+
+    [Required]
+    public DateTime CreatedAt { get; set; }
+}

src/HopFrame.Database/Models/ModelExtensions.cs

@@ -0,0 +1,56 @@
+using HopFrame.Database.Models.Entries;
+
+namespace HopFrame.Database.Models;
+
+public static class ModelExtensions {
+
+    /// <summary>
+    /// Converts the database model to a friendly user model
+    /// </summary>
+    /// <param name="entry">the database model</param>
+    /// <param name="contextBase">the data source for the permissions and users</param>
+    /// <returns></returns>
+    public static User ToUserModel(this UserEntry entry, HopDbContextBase contextBase) {
+        var user = new User {
+            Id = Guid.Parse(entry.Id),
+            Username = entry.Username,
+            Email = entry.Email,
+            CreatedAt = entry.CreatedAt
+        };
+
+        user.Permissions = contextBase.Permissions
+            .Where(perm => perm.UserId == entry.Id)
+            .Select(perm => perm.ToPermissionModel())
+            .ToList();
+
+        return user;
+    }
+
+    public static Permission ToPermissionModel(this PermissionEntry entry) {
+        Guid.TryParse(entry.UserId, out var userId);
+
+        return new Permission {
+            Owner = userId,
+            PermissionName = entry.PermissionText,
+            GrantedAt = entry.GrantedAt,
+            Id = entry.RecordId
+        };
+    }
+
+    public static PermissionGroup ToPermissionGroup(this GroupEntry entry, HopDbContextBase contextBase) {
+        var group = new PermissionGroup {
+            Name = entry.Name,
+            IsDefaultGroup = entry.Default,
+            Description = entry.Description,
+            CreatedAt = entry.CreatedAt
+        };
+
+        group.Permissions = contextBase.Permissions
+            .Where(perm => perm.UserId == group.Name)
+            .Select(perm => perm.ToPermissionModel())
+            .ToList();
+
+        return group;
+    }
+    
+}

src/HopFrame.Database/Models/Permission.cs

@@ -0,0 +1,10 @@
+namespace HopFrame.Database.Models;
+
+public sealed class Permission {
+    public long Id { get; init; }
+    public string PermissionName { get; set; }
+    public Guid Owner { get; set; }
+    public DateTime GrantedAt { get; set; }
+}
+
+public interface IPermissionOwner {}

src/HopFrame.Database/Models/PermissionGroup.cs

@@ -0,0 +1,9 @@
+namespace HopFrame.Database.Models;
+
+public class PermissionGroup : IPermissionOwner {
+    public string Name { get; init; }
+    public bool IsDefaultGroup { get; set; }
+    public string Description { get; set; }
+    public DateTime CreatedAt { get; set; }
+    public IList<Permission> Permissions { get; set; }
+}

src/HopFrame.Database/Models/User.cs

@@ -0,0 +1,9 @@
+namespace HopFrame.Database.Models;
+
+public sealed class User : IPermissionOwner {
+    public Guid Id { get; init; }
+    public string Username { get; set; }
+    public string Email { get; set; }
+    public DateTime CreatedAt { get; set; }
+    public IList<Permission> Permissions { get; set; }
+}

src/HopFrame.Database/README.md

@@ -0,0 +1,2 @@
+# HopFrame Database module
+This module contains all the logic for the database communication