Add support for verification, VerificationView is added to ProfileViewBasic, ProfileView and ProfileViewDetailed.

Document verification on profiles

Author: blowdart

docs/docs/labels.md

@@ -14,7 +14,7 @@ the agent has authenticated.
 using Bluesky.Agent;
 
 Preferences userPreferences;
-AtProtoHttpResult<Preferences> userPreferencesResult = await agent.GetPreferences();
+var userPreferencesResult = await agent.GetPreferences();
 if (userPreferencesResult.Succeeded)
 {
     userPreferences = userPreferencesResult.Result;
@@ -53,6 +53,9 @@ foreach (Notification notification in notificationsList.Result)
 }
 ```
 
+Many APIs will take a `subscribedLabelers` parameters, including `GetProfile`, `GetSuggestions`, `SearchActors`, `GetFeed`, `GetTimeline` and so on.
+It is recommended you cache the user's subscribed labelers and provide them to any API that accepts them.
+
 By default idunno.Bluesky will return the Bluesky moderation labeler as part of a user's labeler subscriptions. This can be controlled
 with the `includeBlueskyModerationLabeler` parameter on the `GetPreferences` method.
 

docs/docs/profiles.md

@@ -0,0 +1,29 @@
+# <a name="profileViewing">Viewing a user's profile</a>
+
+## <a name="gettingAProfile">Getting a profile</a>
+
+To retrieve a user's profile use `agent.GetProfile()`, with either a `Handle` or `Did`.
+
+```c#
+var profileViewResult = await agent.GetProfile(new Handle("blowdart.me"), cancellationToken: cancellationToken);
+```
+
+A user's `ProfileView` includes their `Did`, `Handle`, display name, description, avatar etc. It also includes their follower, following and posts count, information
+on the number of lists, starter packs and feed generators they have created, as well who they will accept direct messages from.
+
+The profile view also includes a `Viewer` property which describes the relationship between the user that requested the profile and the user the profile refers to,
+including properties such as `Muted`, when the user requesting the profile has muted the user the profile refers to, as well as `BlockedBy`, `Following`, `FollowedBy`
+and other properties that will effect how you should render the profile, or the item in a view that also contains the author profile, to the requesting user.
+
+Feeds, timelines etc. will also contain a `ProfileViewBasic`, `ProfileView` or `ProfileViewDetailed`, depending on the view or API definition.
+
+## <a name="profileVerification">Profile labels</a>
+
+Profile views can include labels from labelers. Please see [Labels](labels.md) for more information.
+
+## <a name="profileVerification">Profile verification</a>
+
+Bluesky supports a composible verification system where various organications will verify accounts, for example the New York Times may verify their reporters. The
+`Verification` property holds the verification status for a user, and a list of the verifiers who have verified it. The `VerifiedStatus` can be valid, invalid, none or unknown,
+you can use this to decide if you want to display an indicator of the status to your users.
+

docs/docs/sourceGeneration.md

@@ -55,24 +55,23 @@ and passing in the `JsonSerializerOptions.Default` from your code where you have
 
 ### Annotating your own classes for json source generation
 
-The reference `AtProto` implementation is quite laissez faire about where the `$type` property appears in serialized JSON. Make sure that the `AllowOutOfOrderMetadataProperties` is set
-to `true`` in your `JsonSourceGenerationOptions` on your `SourceGenerationContext` class. For example,
+The reference `AtProto` implementation is quite laissez faire about where the `$type` property appears in serialized JSON. Make sure that the
+`AllowOutOfOrderMetadataProperties` is set to `true`` in your `JsonSourceGenerationOptions` on your `SourceGenerationContext` class. For example,
 
 ```c#
     [JsonSourceGenerationOptions(
         AllowOutOfOrderMetadataProperties = true,
         DefaultIgnoreCondition = JsonIgnoreCondition.WhenWritingNull,
         IgnoreReadOnlyProperties = false,
-        GenerationMode = JsonSourceGenerationMode.Metadata,
         NumberHandling = JsonNumberHandling.AllowReadingFromString,
         PropertyNameCaseInsensitive = true,
         PropertyNamingPolicy = JsonKnownNamingPolicy.CamelCase,
         WriteIndented = false,
         UseStringEnumConverter = true)]
 ```
 
-You must also ensure both your record classes (those deriving from `AtProtoRecord`) and your record value classes (those deriving from `AtProtoRecordValue`) are marked as `JsonSerializable` in your
-`JsonSerializerContext`. Additionally you must also add the `AtProtoRecord<YourRecordValue>` class to the context.
+You must also ensure both your record classes (those deriving from `AtProtoRecord`) and your record value classes (those deriving from `AtProtoRecordValue`) are marked
+as `JsonSerializable` in your `JsonSerializerContext`. Additionally you must also add the `AtProtoRecord<YourRecordValue>` class to the context.
 
 For example, if you have a custom `AtProtoRecordValue` and corresponding `AtProtoRecord<TRecordValue>` it should look something like the following.
 
@@ -93,7 +92,6 @@ For example, if you have a custom `AtProtoRecordValue` and corresponding `AtProt
         AllowOutOfOrderMetadataProperties = true,
         DefaultIgnoreCondition = JsonIgnoreCondition.WhenWritingNull,
         IgnoreReadOnlyProperties = false,
-        GenerationMode = JsonSourceGenerationMode.Metadata,
         NumberHandling = JsonNumberHandling.AllowReadingFromString,
         PropertyNameCaseInsensitive = true,
         PropertyNamingPolicy = JsonKnownNamingPolicy.CamelCase,
@@ -119,3 +117,6 @@ Native AOT has benefits:
 * Reduced memory usage: Native AOT apps can show reduced memory demands, depending on the work it does.
 
 If you wish to use AOT with your own classes you must enable JSON Source Generation for your `AtProtoRecordValue` and `AtProtoRecord` records and follow the guidance above.
+
+> [!WARNING]
+> Trimming is not currently supported due to a bug in the [linker](https://github.com/dotnet/runtime/issues/114307).

docs/docs/toc.yml

@@ -26,6 +26,8 @@ items:
 
   - name: Users
     items:
+      - name: Viewing user profiles
+        href: profiles.md
       - name: User Preferences
         href: userPreferences.md
       - name: Conversations & Messages

history.md

@@ -1,5 +1,13 @@
 # Version History
 
+## 0.6.0
+
+### Features
+
+#### idunno.Bluesky
+
+* Add support for verification, `VerificationView` is added to `ProfileViewBasic`, `ProfileView` and `ProfileViewDetailed`.
+
 ## 0.5.0
 
 ### Bug Fixes

idunno.Bluesky.sln

@@ -137,6 +137,7 @@ Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "docs", "docs", "{E2B63F0A-9
 		docs\docs\notifications.md = docs\docs\notifications.md
 		docs\docs\posting.md = docs\docs\posting.md
 		docs\docs\profileEditing.md = docs\docs\profileEditing.md
+		docs\docs\profiles.md = docs\docs\profiles.md
 		docs\docs\savingAndRestoringAuthentication.md = docs\docs\savingAndRestoringAuthentication.md
 		docs\docs\sourceGeneration.md = docs\docs\sourceGeneration.md
 		docs\docs\threadGatesAndPostGates.md = docs\docs\threadGatesAndPostGates.md

samples/Samples.ConsoleShell/Program.cs

@@ -7,12 +7,10 @@
 
 using Microsoft.Extensions.Logging;
 
-using idunno.Bluesky;
-
 using Samples.Common;
+
 using idunno.AtProto;
-using idunno.AtProto.Repo;
-using idunno.Bluesky.Moderation;
+using idunno.Bluesky;
 
 namespace Samples.ConsoleShell
 {
@@ -35,7 +33,7 @@ static async Task PerformOperations(string? handle, string? password, string? au
             ArgumentException.ThrowIfNullOrEmpty(password);
 
             // Uncomment the next line to route all requests through Fiddler Everywhere
-            proxyUri = new Uri("http://localhost:8866");
+            // proxyUri = new Uri("http://localhost:8866");
 
             // Uncomment the next line to route all requests  through Fiddler Classic
             // proxyUri = new Uri("http://localhost:8888");

src/idunno.Bluesky/Actor/ProfileView.cs

@@ -26,6 +26,7 @@ public record ProfileView : ProfileViewBasic
         /// <param name="createdAt">The date and time the actor was created.</param>
         /// <param name="viewer">Metadata about the current user's relationship to the actor.</param>
         /// <param name="labels">Labels applied to the actor.</param>
+        /// <param name="verification">The <see cref="VerificationState"/> of the actor, if any.</param>
         /// <exception cref="ArgumentNullException">Thrown when <paramref name="did"/> or <paramref name="handle"/> are null.</exception>
         /// <exception cref="ArgumentOutOfRangeException">
         ///   Thrown when <paramref name="displayName"/> is not null and has a character length greater than 640 or a grapheme length greater than 64.
@@ -41,7 +42,9 @@ public ProfileView(
             ActorViewerState? viewer,
             IReadOnlyCollection<Label>? labels,
             DateTimeOffset? indexedAt,
-            DateTimeOffset? createdAt) : base(did, handle, displayName, avatar, associated, viewer, labels, createdAt)
+            DateTimeOffset? createdAt,
+            VerificationState? verification
+            ) : base(did, handle, displayName, avatar, associated, viewer, labels, createdAt, verification)
         {
             Description = description;
             IndexedAt = indexedAt;

src/idunno.Bluesky/Actor/ProfileViewBasic.cs

@@ -30,6 +30,7 @@ public record ProfileViewBasic : View
         /// <param name="viewer">Metadata about the current user's relationship to the actor.</param>
         /// <param name="labels">Labels applied to the actor.</param>
         /// <param name="createdAt">The date and time the actor was created.</param>
+        /// <param name="verification">The <see cref="VerificationState"/> of the actor, if any.</param>
         /// <exception cref="ArgumentNullException">Thrown when <paramref name="did"/> or <paramref name="handle"/> are null.</exception>
         /// <exception cref="ArgumentOutOfRangeException">
         ///   Thrown when <paramref name="displayName"/> is not null and has a character length greater than 640 or a grapheme length greater than 64.
@@ -43,7 +44,8 @@ public ProfileViewBasic(
             ProfileAssociated? associated,
             ActorViewerState? viewer,
             IReadOnlyCollection<Label>? labels,
-            DateTimeOffset? createdAt)
+            DateTimeOffset? createdAt,
+            VerificationState? verification)
         {
             ArgumentNullException.ThrowIfNull(did);
             ArgumentNullException.ThrowIfNull(handle);
@@ -61,6 +63,7 @@ public ProfileViewBasic(
             Associated = associated;
             Viewer = viewer;
             CreatedAt = createdAt;
+            Verification = verification;
 
             if (labels is null)
             {
@@ -107,21 +110,26 @@ public ProfileViewBasic(
         public ActorViewerState? Viewer { get; init; }
 
         /// <summary>
-        /// Any labels applied to the actor.
+        /// Gets any labels applied to the actor.
         /// </summary>
         /// <remarks>
         ///<para>
-        ///Labels will only be populated if a list of subscribed labelers from a user's <see cref="Preferences"/>
-        ///is passed into an API which returns this class.
+        /// Labels will only be populated if a list of subscribed labelers from a user's <see cref="Preferences"/>
+        /// is passed into an API which returns this class.
         ///</para>
         /// </remarks>
         public IReadOnlyCollection<Label> Labels { get; init; }
 
         /// <summary>
-        /// The date and time the actor was created at.
+        /// Gets the date and time the actor was created at.
         /// </summary>
         public DateTimeOffset? CreatedAt { get; init; }
 
+        /// <summary>
+        /// Gets the <see cref="VerificationState"/> of the actor, if any.
+        /// </summary>
+        public VerificationState? Verification { get; init; }
+
         /// <summary>
         /// Gets a string representation of the <see cref="ProfileView"/>.
         /// This returns the actor's display name, if any, otherwise returns the actor's handle.

src/idunno.Bluesky/Actor/ProfileViewDetailed.cs

@@ -32,6 +32,7 @@ public sealed record ProfileViewDetailed : ProfileView
         /// <param name="indexedAt">The date and time the actor was last indexed.</param>
         /// <param name="createdAt">The date and time the actor was created.</param>
         /// <param name="banner">A <see cref="Uri"/> to the actor's banner image.</param>
+        /// <param name="verification">The <see cref="VerificationState"/> of the actor, if any.</param>
         /// <param name="followersCount">The actor's current follower count.</param>
         /// <param name="followsCount">The number of actors the actor follows.</param>
         /// <param name="postsCount">The number of posts the actor has made.</param>
@@ -54,12 +55,13 @@ public ProfileViewDetailed(
             IReadOnlyCollection<Label>? labels,
             DateTimeOffset? indexedAt,
             DateTimeOffset? createdAt,
+            VerificationState? verification,
             StarterPackViewBasic? joinedViaStarterPack = null,
             StrongReference? pinnedPost = null,
             int followersCount = 0,
             int followsCount = 0,
             int postsCount = 0
-            ) : base(did, handle, displayName, description, avatar, associated, viewer, labels, indexedAt, createdAt)
+            ) : base(did, handle, displayName, description, avatar, associated, viewer, labels, indexedAt, createdAt, verification)
         {
             Banner = banner;
             FollowersCount = followersCount;