Skip to content

Commit 90642f2

Browse files
ArlodotexeArlodotexe
authored
Merge pull request #41 from WindowsAppCommunity/copilot/fix-40
Add comprehensive interface inheritance hierarchy for Publisher, Project, and User entities
2 parents 2cc355c + db9e910 commit 90642f2

File tree

1 file changed

+271
-0
lines changed

1 file changed

+271
-0
lines changed

‎docs/reference/INTERFACE_INVENTORY.md‎

Lines changed: 271 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,271 @@
1+
# Interface Graph Inventory for WindowsAppCommunity.Sdk
2+
3+
This document provides a comprehensive inventory of the interface hierarchy for the three main entities in the WindowsAppCommunity.Sdk: **Publisher**, **Project**, and **User**. This mapping helps developers understand the type relationships and data access patterns.
4+
5+
## Core Entity Interfaces
6+
7+
### IReadOnlyUser
8+
```
9+
IReadOnlyUser : IReadOnlyEntity, IReadOnlyPublisherRoleCollection, IReadOnlyProjectRoleCollection, IHasId
10+
```
11+
12+
**Purpose**: Represents a user with access to their entity data, publisher roles, and project roles.
13+
14+
**Key Properties**:
15+
- Inherits all properties from `IReadOnlyEntity` (name, description, connections, links, images)
16+
- Access to publisher roles via `IReadOnlyPublisherRoleCollection`
17+
- Access to project roles via `IReadOnlyProjectRoleCollection`
18+
19+
### IReadOnlyPublisher
20+
```
21+
IReadOnlyPublisher : IReadOnlyPublisher<IReadOnlyPublisherRoleCollection>
22+
23+
IReadOnlyPublisher<TPublisherCollection> : IReadOnlyEntity, IReadOnlyAccentColor, IReadOnlyUserRoleCollection, IReadOnlyProjectCollection, IHasId
24+
where TPublisherCollection : IReadOnlyPublisherCollection<IReadOnlyPublisherRole>
25+
```
26+
27+
**Purpose**: Represents a publisher entity with accent color, user roles, projects, and hierarchical publisher relationships.
28+
29+
**Key Properties**:
30+
- Inherits all properties from `IReadOnlyEntity` (name, description, connections, links, images)
31+
- `AccentColor` via `IReadOnlyAccentColor`
32+
- User roles via `IReadOnlyUserRoleCollection`
33+
- Projects via `IReadOnlyProjectCollection`
34+
- `ParentPublishers` and `ChildPublishers` (hierarchical relationships)
35+
36+
### IReadOnlyProject
37+
```
38+
IReadOnlyProject : IReadOnlyProject<IReadOnlyProjectCollection>
39+
40+
IReadOnlyProject<TDependencyCollection> : IReadOnlyEntity, IReadOnlyImagesCollection, IReadOnlyUserRoleCollection, IReadOnlyAccentColor, IReadOnlyFeaturesCollection, IHasId
41+
where TDependencyCollection : IReadOnlyProjectCollection<IReadOnlyProject>
42+
```
43+
44+
**Purpose**: Represents a project entity with dependencies, features, accent color, users, and images.
45+
46+
**Key Properties**:
47+
- Inherits all properties from `IReadOnlyEntity` (name, description, connections, links, images)
48+
- Additional images via `IReadOnlyImagesCollection`
49+
- User roles via `IReadOnlyUserRoleCollection`
50+
- `AccentColor` via `IReadOnlyAccentColor`
51+
- `Features` via `IReadOnlyFeaturesCollection`
52+
- `Dependencies` (other projects this project depends on)
53+
- `Category` (string property for app store categorization)
54+
- `GetPublisherAsync()` method to retrieve associated publisher
55+
56+
## Supporting Interface Hierarchy
57+
58+
### Base Entity Interface
59+
```
60+
IReadOnlyEntity : IReadOnlyConnectionsCollection, IReadOnlyLinksCollection, IReadOnlyImagesCollection, IHasId
61+
```
62+
63+
**Properties**:
64+
- `Name` (string)
65+
- `Description` (string, supports markdown)
66+
- `ExtendedDescription` (string, supports markdown)
67+
- `ForgetMe` (bool?)
68+
- `IsUnlisted` (bool)
69+
70+
**Events**:
71+
- `NameUpdated`
72+
- `DescriptionUpdated`
73+
- `ExtendedDescriptionUpdated`
74+
- `ForgetMeUpdated`
75+
- `IsUnlistedUpdated`
76+
77+
### Collection Interfaces
78+
79+
#### IReadOnlyConnectionsCollection
80+
```
81+
IReadOnlyConnectionsCollection : IHasId
82+
```
83+
- `GetConnectionsAsync()` → `IAsyncEnumerable<IReadOnlyConnection>`
84+
- Events: `ConnectionsAdded`, `ConnectionsRemoved`
85+
86+
#### IReadOnlyLinksCollection
87+
```
88+
IReadOnlyLinksCollection : IHasId
89+
```
90+
- `Links` (Link[] property)
91+
- Events: `LinksAdded`, `LinksRemoved`
92+
93+
#### IReadOnlyImagesCollection
94+
```
95+
IReadOnlyImagesCollection : IHasId
96+
```
97+
- `GetImageFilesAsync()` → `IAsyncEnumerable<IFile>`
98+
- Events: `ImagesAdded`, `ImagesRemoved`
99+
100+
#### IReadOnlyAccentColor
101+
```
102+
IReadOnlyAccentColor : IHasId
103+
```
104+
- `AccentColor` (string?)
105+
- Events: `AccentColorUpdated`
106+
107+
#### IReadOnlyFeaturesCollection
108+
```
109+
IReadOnlyFeaturesCollection : IHasId
110+
```
111+
- `Features` (string[])
112+
- Events: `FeaturesAdded`, `FeaturesRemoved`
113+
114+
### Role-Based Collections
115+
116+
#### IReadOnlyUserRoleCollection
117+
```
118+
IReadOnlyUserRoleCollection : IReadOnlyUserCollection<IReadOnlyUserRole>
119+
IReadOnlyUserCollection<TUser> : IHasId where TUser : IReadOnlyUser
120+
```
121+
- `GetUsersAsync()` → `IAsyncEnumerable<TUser>`
122+
123+
#### IReadOnlyProjectRoleCollection
124+
```
125+
IReadOnlyProjectRoleCollection : IReadOnlyProjectCollection<IReadOnlyProjectRole>
126+
```
127+
128+
#### IReadOnlyPublisherRoleCollection
129+
```
130+
IReadOnlyPublisherRoleCollection : IReadOnlyPublisherCollection<IReadOnlyPublisherRole>
131+
```
132+
133+
#### IReadOnlyProjectCollection
134+
```
135+
IReadOnlyProjectCollection<TProject> : IHasId where TProject : IReadOnlyProject
136+
```
137+
- `GetProjectsAsync()` → `IAsyncEnumerable<TProject>`
138+
- Events: `ProjectsAdded`, `ProjectsRemoved`
139+
140+
#### IReadOnlyPublisherCollection
141+
```
142+
IReadOnlyPublisherCollection<TPublisher> : IHasId where TPublisher : IReadOnlyPublisher
143+
```
144+
- `GetPublishersAsync()` → `IAsyncEnumerable<TPublisher>`
145+
- Events: `PublishersAdded`, `PublishersRemoved`
146+
147+
### Role Interfaces
148+
149+
#### IReadOnlyUserRole
150+
```
151+
IReadOnlyUserRole : IReadOnlyUser
152+
```
153+
- `Role` (Role property)
154+
155+
#### IReadOnlyProjectRole
156+
```
157+
IReadOnlyProjectRole : IReadOnlyProject
158+
```
159+
- `Role` (Role property)
160+
161+
#### IReadOnlyPublisherRole
162+
```
163+
IReadOnlyPublisherRole : IReadOnlyPublisher
164+
```
165+
- `Role` (Role property)
166+
167+
## Supporting Data Classes
168+
169+
### Role
170+
```csharp
171+
public class Role
172+
{
173+
public required string Id { get; init; }
174+
public required string Name { get; init; }
175+
public required string Description { get; init; }
176+
}
177+
```
178+
179+
### Link
180+
```csharp
181+
public class Link : IStorable
182+
{
183+
public required string Id { get; init; }
184+
public required string Url { get; set; }
185+
public required string Name { get; set; }
186+
public required string Description { get; set; }
187+
}
188+
```
189+
190+
### IReadOnlyConnection
191+
```csharp
192+
public interface IReadOnlyConnection
193+
{
194+
string Id { get; }
195+
Task<string> GetValueAsync(CancellationToken cancellationToken = default);
196+
event EventHandler<string>? ValueUpdated;
197+
}
198+
```
199+
200+
## Complete Interface Inheritance Hierarchies
201+
202+
### IReadOnlyUser Interface Hierarchy
203+
204+
```
205+
IReadOnlyUser
206+
├── IReadOnlyEntity
207+
│ ├── IReadOnlyConnectionsCollection
208+
│ │ └── IHasId
209+
│ ├── IReadOnlyLinksCollection
210+
│ │ └── IHasId
211+
│ ├── IReadOnlyImagesCollection
212+
│ │ └── IHasId
213+
│ └── IHasId
214+
├── IReadOnlyPublisherRoleCollection
215+
│ └── IReadOnlyPublisherCollection<IReadOnlyPublisherRole>
216+
│ └── IHasId
217+
├── IReadOnlyProjectRoleCollection
218+
│ └── IReadOnlyProjectCollection<IReadOnlyProjectRole>
219+
│ └── IHasId
220+
└── IHasId
221+
```
222+
223+
### IReadOnlyProject Interface Hierarchy
224+
225+
```
226+
IReadOnlyProject
227+
└── IReadOnlyProject<TDependencyCollection>
228+
├── IReadOnlyEntity
229+
│ ├── IReadOnlyConnectionsCollection
230+
│ │ └── IHasId
231+
│ ├── IReadOnlyLinksCollection
232+
│ │ └── IHasId
233+
│ ├── IReadOnlyImagesCollection
234+
│ │ └── IHasId
235+
│ └── IHasId
236+
├── IReadOnlyImagesCollection
237+
│ └── IHasId
238+
├── IReadOnlyUserRoleCollection
239+
│ └── IReadOnlyUserCollection<IReadOnlyUserRole>
240+
│ └── IHasId
241+
├── IReadOnlyAccentColor
242+
│ └── IHasId
243+
├── IReadOnlyFeaturesCollection
244+
│ └── IHasId
245+
└── IHasId
246+
```
247+
248+
### IReadOnlyPublisher Interface Hierarchy
249+
250+
```
251+
IReadOnlyPublisher
252+
└── IReadOnlyPublisher<TPublisherCollection>
253+
├── IReadOnlyEntity
254+
│ ├── IReadOnlyConnectionsCollection
255+
│ │ └── IHasId
256+
│ ├── IReadOnlyLinksCollection
257+
│ │ └── IHasId
258+
│ ├── IReadOnlyImagesCollection
259+
│ │ └── IHasId
260+
│ └── IHasId
261+
├── IReadOnlyAccentColor
262+
│ └── IHasId
263+
├── IReadOnlyUserRoleCollection
264+
│ └── IReadOnlyUserCollection<IReadOnlyUserRole>
265+
│ └── IHasId
266+
├── IReadOnlyProjectCollection
267+
│ └── IHasId
268+
└── IHasId
269+
```
270+
271+
This interface inventory provides a comprehensive reference for understanding the type hierarchy and relationships within the WindowsAppCommunity.Sdk.

0 commit comments

Comments
 (0)