Merge pull request #36 from WindowsAppCommunity/arlo/esh-repositories/nomadkubo/0.16.0

Refactored root event stream handler repositories, update to OwlCore.Nomad.Kubo 0.16.0

Author: Arlodotexe

src/Models/IImages.cs

@@ -1,5 +1,3 @@
-using Ipfs;
-
 namespace WindowsAppCommunity.Sdk.Models;
 
 /// <summary>

src/Models/IProjectRoleCollection.cs

@@ -10,5 +10,21 @@ public interface IProjectRoleCollection
     /// <summary>
     /// Represents a list of registered projects along with the role on each.
     /// </summary>
-    (Cid ProjectId, DagCid RoleCid)[] Projects { get; set; }
+    ProjectRole[] Projects { get; set; }
 }
+
+/// <summary>
+/// A container for a project and a corresponding role.
+/// </summary>
+public record ProjectRole
+{
+    /// <summary>
+    /// The project ID.
+    /// </summary>
+    public required Cid ProjectId { get; init; }
+
+    /// <summary>
+    /// The role of the project.
+    /// </summary>
+    public required DagCid Role { get; init; }
+}

src/Models/IPublisherRoleCollection.cs

@@ -10,5 +10,21 @@ public interface IPublisherRoleCollection
     /// <summary>
     /// Represents a list of registered publishers along with the role on each.
     /// </summary>
-    public (Cid PublisherId, DagCid RoleCid)[] Publishers { get; set; }
+    public PublisherRole[] Publishers { get; set; }
+}
+
+/// <summary>
+/// A container for a Publisher and a corresponding role.
+/// </summary>
+public record PublisherRole
+{
+    /// <summary>
+    /// The publisher ID.
+    /// </summary>
+    public required Cid PublisherId { get; init; }
+
+    /// <summary>
+    /// The role of the publisher.
+    /// </summary>
+    public required DagCid Role { get; init; } 
 }

src/Models/IUserRoleCollection.cs

@@ -10,5 +10,21 @@ public interface IUserRoleCollection
     /// <summary>
     /// Represents a list of registered users along with the role on each.
     /// </summary>
-    public (Cid UserId, DagCid RoleCid)[] Users { get; set; }
+    public UserRole[] Users { get; set; }
+}
+
+/// <summary>
+/// A container for a user and a corresponding role.
+/// </summary>
+public record UserRole
+{
+    /// <summary>
+    /// The user ID.
+    /// </summary>
+    public required Cid UserId { get; init; }
+
+    /// <summary>
+    /// The role of the user.
+    /// </summary>
+    public required DagCid Role { get; init; } 
 }

src/Models/Project.cs

@@ -17,17 +17,17 @@ public record Project : IEntity, IUserRoleCollection, IAccentColor, IProjectColl
     /// <summary>
     /// The name of this project.
     /// </summary>
-    public required string Name { get; set; }
+    public string Name { get; set; } = string.Empty;
 
     /// <summary>
     /// A description of this project.
     /// </summary>
-    public required string Description { get; set; }
+    public string Description { get; set; } = string.Empty;
 
     /// <summary>
     /// An extended description of this project.
     /// </summary>
-    public required string ExtendedDescription { get; set; }
+    public string ExtendedDescription { get; set; } = string.Empty;
 
     /// <summary>
     /// A list of <see cref="Image"/>s demonstrating this project.
@@ -47,7 +47,7 @@ public record Project : IEntity, IUserRoleCollection, IAccentColor, IProjectColl
     /// <summary>
     /// The category defining this project, as found in an app store.
     /// </summary>
-    public required string Category { get; set; }
+    public string Category { get; set; } = string.Empty;
 
     /// <summary>
     /// Other projects which this project may depend on for various reasons.
@@ -57,7 +57,7 @@ public record Project : IEntity, IUserRoleCollection, IAccentColor, IProjectColl
     /// <summary>
     /// The <see cref="User"/>s who collaborate on this project, and their corresponding roles.
     /// </summary>
-    public (Cid, DagCid)[] Users { get; set; } = [];
+    public UserRole[] Users { get; set; } = [];
 
     /// <summary>
     /// Represents links to external profiles or resources added by the user.

src/Models/Publisher.cs

@@ -12,17 +12,17 @@ public record Publisher : IEntity, ILinkCollection, IProjectCollection, IUserRol
     /// <summary>
     /// The name of the publisher.
     /// </summary>
-    public required string Name { get; set; }
+    public string Name { get; set; } = string.Empty;
 
     /// <summary>
     /// A description of the publisher.
     /// </summary>
-    public required string Description { get; set; }
+    public string Description { get; set; } = string.Empty;
 
     /// <summary>
     /// An extended description of the publisher.
     /// </summary>
-    public required string ExtendedDescription { get; set; }
+    public string ExtendedDescription { get; set; } = string.Empty;
 
     /// <summary>
     /// A hex-encoded accent color for this publisher.
@@ -42,7 +42,7 @@ public record Publisher : IEntity, ILinkCollection, IProjectCollection, IUserRol
     /// <summary>
     /// Users who are registered to participate in this publisher, along with their roles.
     /// </summary>
-    public (Cid, DagCid)[] Users { get; set; } = [];
+    public UserRole[] Users { get; set; } = [];
 
     /// <summary>
     /// Projects who are registered under this publisher.

src/Models/User.cs

@@ -12,17 +12,17 @@ public record User : IEntity, IConnections, ILinkCollection, IProjectRoleCollect
     /// <summary>
     /// The name of the user.
     /// </summary>
-    public required string Name { get; set; }
+    public string Name { get; set; } = string.Empty;
 
     /// <summary>
     /// A description of the user. Supports markdown.
     /// </summary>
-    public required string Description { get; set;  }
+    public string Description { get; set; } = string.Empty;
 
     /// <summary>
     /// An extended description of the user. Supports markdown.
     /// </summary>
-    public required string ExtendedDescription { get; set; }
+    public string ExtendedDescription { get; set; } = string.Empty;
 
     /// <summary>
     /// Represents application connections added by the user.
@@ -42,12 +42,12 @@ public record User : IEntity, IConnections, ILinkCollection, IProjectRoleCollect
     /// <summary>
     /// A list of all the projects the user is registered with, along with their role on the project.
     /// </summary>
-    public (Cid, DagCid)[] Projects { get; set; } = [];
+    public ProjectRole[] Projects { get; set; } = [];
 
     /// <summary>
     /// Represents all publishers the user is registered with, along with their roles.
     /// </summary>
-    public (Cid, DagCid)[] Publishers { get; set; } = [];
+    public PublisherRole[] Publishers { get; set; } = [];
 
     /// <summary>
     /// A flag that indicates whether the profile has requested to be forgotten.

src/Nomad/ModifiableEntity.cs

@@ -1,5 +1,4 @@
 using System.Collections.Generic;
-using System.Diagnostics;
 using CommunityToolkit.Diagnostics;
 using Ipfs;
 using OwlCore.ComponentModel;

src/Nomad/ModifiableProject.cs

@@ -27,7 +27,7 @@ public class ModifiableProject : NomadKuboEventStreamHandler<ValueUpdateEvent>,
     /// <param name="client">The client used to interact with the ipfs network.</param>
     /// <param name="kuboOptions">The options used to read and write data to and from Kubo.</param>
     /// <returns>A new instance of <see cref="ModifiableProject"/>.</returns>
-    public static ModifiableProject FromHandlerConfig(NomadKuboEventStreamHandlerConfig<Project> handlerConfig, NomadKuboRepository<ModifiableProject, IReadOnlyProject, Project, ValueUpdateEvent> projectDependencyRepository, NomadKuboRepository<ModifiablePublisher, IReadOnlyPublisher, Publisher, ValueUpdateEvent> publisherRepository, NomadKuboRepository<ModifiableUser, IReadOnlyUser, User, ValueUpdateEvent> userRepository, ICoreApi client, IKuboOptions kuboOptions)
+    public static ModifiableProject FromHandlerConfig(NomadKuboEventStreamHandlerConfig<Project> handlerConfig, INomadKuboRepositoryBase<ModifiableProject, IReadOnlyProject> projectDependencyRepository, INomadKuboRepositoryBase<ModifiablePublisher, IReadOnlyPublisher> publisherRepository, INomadKuboRepositoryBase<ModifiableUser, IReadOnlyUser> userRepository, ICoreApi client, IKuboOptions kuboOptions)
     {
         Guard.IsNotNull(handlerConfig.RoamingValue);
         Guard.IsNotNull(handlerConfig.RoamingKey);
@@ -168,7 +168,7 @@ public static ModifiableProject FromHandlerConfig(NomadKuboEventStreamHandlerCon
     /// <summary>
     /// A repository to get modifiable or readonly project instances from.
     /// </summary>
-    public required NomadKuboRepository<ModifiablePublisher, IReadOnlyPublisher, Publisher, ValueUpdateEvent> PublisherRepository { get; init; }
+    public required INomadKuboRepositoryBase<ModifiablePublisher, IReadOnlyPublisher> PublisherRepository { get; init; }
 
     /// <inheritdoc/>
     public string Category => InnerProject.Category;

src/Nomad/ModifiableProjectCollection.cs

@@ -5,7 +5,6 @@
 using OwlCore.Nomad;
 using OwlCore.Nomad.Kubo;
 using OwlCore.Nomad.Kubo.Events;
-using WindowsAppCommunity.Sdk.Models;
 
 namespace WindowsAppCommunity.Sdk.Nomad;
 
@@ -23,7 +22,7 @@ public class ModifiableProjectCollection : NomadKuboEventStreamHandler<ValueUpda
     /// <summary>
     /// The repository to use for getting modifiable or readonly project instances.
     /// </summary>
-    public required NomadKuboRepository<ModifiableProject, IReadOnlyProject, Project, ValueUpdateEvent> ProjectRepository { get; init; }
+    public required INomadKuboRepositoryBase<ModifiableProject, IReadOnlyProject> ProjectRepository { get; init; }
 
     /// <inheritdoc/>
     public event EventHandler<IReadOnlyProject[]>? ProjectsAdded;