Merge pull request #33 from WindowsAppCommunity/arlo/event-stream-handlers

Implement Entity, User, Project, Publisher and containing role/non-role collections

Author: Arlodotexe

src/IModifiableProject.cs

@@ -3,7 +3,7 @@
 /// <summary>
 /// Represents a project that can be modified.
 /// </summary>
-public interface IModifiableProject : IReadOnlyProject, IModifiableEntity, IModifiableImagesCollection, IModifiableUserRoleCollection, IModifiableAccentColor, IModifiableFeaturesCollection
+public interface IModifiableProject : IReadOnlyProject, IReadOnlyProject<IModifiableProjectCollection<IReadOnlyProject>>, IModifiableEntity, IModifiableImagesCollection, IModifiableUserRoleCollection, IModifiableAccentColor, IModifiableFeaturesCollection
 {
     /// <summary>
     /// Updates the publisher for this project.

src/IModifiablePublisher.cs

@@ -3,6 +3,6 @@
 /// <summary>
 /// Represents a content publisher that can be modified.
 /// </summary>
-public interface IModifiablePublisher : IReadOnlyPublisher, IModifiableEntity, IModifiableAccentColor, IModifiableUserRoleCollection
+public interface IModifiablePublisher : IReadOnlyPublisher<IModifiablePublisherCollection<IReadOnlyPublisher>>, IReadOnlyPublisher, IModifiableEntity, IModifiableAccentColor, IModifiableUserRoleCollection
 {
 }

src/IReadOnlyEntity.cs

@@ -1,9 +1,11 @@
+using OwlCore.ComponentModel;
+
 namespace WindowsAppCommunity.Sdk;
 
 /// <summary>
 /// Represents a read-only entity with common properties and events.
 /// </summary>
-public interface IReadOnlyEntity : IReadOnlyConnectionsCollection, IReadOnlyLinksCollection, IReadOnlyImagesCollection
+public interface IReadOnlyEntity : IReadOnlyConnectionsCollection, IReadOnlyLinksCollection, IReadOnlyImagesCollection, IHasId
 {
     /// <summary>
     /// The name of the entity.
@@ -49,7 +51,7 @@ public interface IReadOnlyEntity : IReadOnlyConnectionsCollection, IReadOnlyLink
     /// Raised when <see cref="ForgetMe"/> is updated.
     /// </summary>
     event EventHandler<bool?>? ForgetMeUpdated;
-    
+
     /// <summary>
     /// Raised when <see cref="IsUnlisted"/> is updated.
     /// </summary>

src/IReadOnlyFeaturesCollection.cs

@@ -13,5 +13,10 @@ public interface IReadOnlyFeaturesCollection
     /// <summary>
     /// Raised when <see cref="Features"/> is updated.
     /// </summary>
-    public event EventHandler<string[]>? FeaturesUpdated;
+    public event EventHandler<string[]>? FeaturesAdded;
+    
+    /// <summary>
+    /// Raised when <see cref="Features"/> is updated.
+    /// </summary>
+    public event EventHandler<string[]>? FeaturesRemoved;
 }

src/IReadOnlyLinksCollection.cs

@@ -11,7 +11,12 @@ public interface IReadOnlyLinksCollection
     Link[] Links { get; }
 
     /// <summary>
-    /// Raised when <see cref="Links"/> is updated.
+    /// Raised when <see cref="Links"/> are added.
     /// </summary>
-    event EventHandler<Link[]>? LinksUpdated;  
+    event EventHandler<Link[]>? LinksAdded;  
+
+    /// <summary>
+    /// Raised when <see cref="Links"/> are removed.
+    /// </summary>
+    event EventHandler<Link[]>? LinksRemoved;  
 }

src/IReadOnlyProject.cs

@@ -1,4 +1,6 @@
-namespace WindowsAppCommunity.Sdk;
+using OwlCore.ComponentModel;
+
+namespace WindowsAppCommunity.Sdk;
 
 /// <summary>
 /// Represents a project.
@@ -10,8 +12,8 @@ public interface IReadOnlyProject : IReadOnlyProject<IReadOnlyProjectCollection>
 /// <summary>
 /// Represents a project.
 /// </summary>
-public interface IReadOnlyProject<out TDependencyCollection> : IReadOnlyEntity, IReadOnlyImagesCollection, IReadOnlyUserRoleCollection, IReadOnlyAccentColor, IReadOnlyFeaturesCollection
-    where TDependencyCollection : IReadOnlyProjectCollection
+public interface IReadOnlyProject<out TDependencyCollection> : IReadOnlyEntity, IReadOnlyImagesCollection, IReadOnlyUserRoleCollection, IReadOnlyAccentColor, IReadOnlyFeaturesCollection, IHasId
+    where TDependencyCollection : IReadOnlyProjectCollection<IReadOnlyProject>
 {
     /// <summary>
     /// The projects that this project depends on.
@@ -31,7 +33,7 @@ public interface IReadOnlyProject<out TDependencyCollection> : IReadOnlyEntity,
     /// <summary>
     /// Raised when <see cref="Dependencies"/> are updated. 
     /// </summary>
-    public event EventHandler<IReadOnlyPublisher> PublisherUpdated;
+    public event EventHandler<IReadOnlyPublisher>? PublisherUpdated;
 
     /// <summary>
     /// Gets the publisher for this project.

src/IReadOnlyProjectCollection.cs

@@ -1,4 +1,5 @@
 using System.Collections.Generic;
+using OwlCore.ComponentModel;
 
 namespace WindowsAppCommunity.Sdk;
 
@@ -12,7 +13,7 @@ public interface IReadOnlyProjectCollection : IReadOnlyProjectCollection<IReadOn
 /// <summary>
 /// Represents a collection of projects.
 /// </summary>
-public interface IReadOnlyProjectCollection<TProject>
+public interface IReadOnlyProjectCollection<TProject> : IHasId
     where TProject : IReadOnlyProject
 {
     /// <summary>

src/IReadOnlyPublisher.cs

@@ -1,4 +1,6 @@
-namespace WindowsAppCommunity.Sdk;
+using OwlCore.ComponentModel;
+
+namespace WindowsAppCommunity.Sdk;
 
 /// <summary>
 /// Represents a publisher, a collection of projects and collaborators who publish content to users.
@@ -10,16 +12,16 @@ public interface IReadOnlyPublisher : IReadOnlyPublisher<IReadOnlyPublisherColle
 /// <summary>
 /// Represents a publisher, a collection of projects and collaborators who publish content to users.
 /// </summary>
-public interface IReadOnlyPublisher<TPublisherCollection> : IReadOnlyEntity, IReadOnlyAccentColor, IReadOnlyUserRoleCollection
-    where TPublisherCollection : IReadOnlyPublisherCollection
+public interface IReadOnlyPublisher<TPublisherCollection> : IReadOnlyEntity, IReadOnlyAccentColor, IReadOnlyUserRoleCollection, IReadOnlyProjectCollection, IHasId
+    where TPublisherCollection : IReadOnlyPublisherCollection<IReadOnlyPublisher>
 {
     /// <summary>
     /// The collection of publishers that this publisher belongs to.
     /// </summary>
-    public TPublisherCollection ParentPublishers { get; set; }
+    public TPublisherCollection ParentPublishers { get; }
 
     /// <summary>
     /// The collection of publishers that belong to this publisher.
     /// </summary>
-    public TPublisherCollection ChildPublishers { get; set; }
+    public TPublisherCollection ChildPublishers { get; }
 }

src/IReadOnlyPublisherCollection.cs

@@ -1,4 +1,5 @@
 using System.Collections.Generic;
+using OwlCore.ComponentModel;
 
 namespace WindowsAppCommunity.Sdk;
 
@@ -12,7 +13,7 @@ public interface IReadOnlyPublisherCollection : IReadOnlyPublisherCollection<IRe
 /// <summary>
 /// Represents a collection of publishers that can be read but not modified.
 /// </summary>
-public interface IReadOnlyPublisherCollection<TPublisher>
+public interface IReadOnlyPublisherCollection<TPublisher> : IHasId
     where TPublisher : IReadOnlyPublisher
 {
     /// <summary>

src/IReadOnlyUser.cs

@@ -1,8 +1,10 @@
-namespace WindowsAppCommunity.Sdk;
+using OwlCore.ComponentModel;
+
+namespace WindowsAppCommunity.Sdk;
 
 /// <summary>
 /// Represents a user.
 /// </summary>
-public interface IReadOnlyUser : IReadOnlyEntity, IReadOnlyPublisherRoleCollection, IReadOnlyProjectRoleCollection
+public interface IReadOnlyUser : IReadOnlyEntity, IReadOnlyPublisherRoleCollection, IReadOnlyProjectRoleCollection, IHasId
 {
 }