Add support for embedding posts in messages.

Fix SendMessage #169

Author: blowdart

docs/docs/conversationsAndMessages.md

@@ -22,7 +22,7 @@ If you already have a conversation ID you can use `GetConversation` to retrieve
 To retrieve the messages in a conversation use `GetMessages`:
 
 ```c#
-var getMessagesResult = await agent.GetMessages(conversationId, cancellationToken: cancellationToken);
+var getMessagesResult = await agent.GetMessages(conversationId);
 ```
 
 The returns a [pageable list](cursorsAndPagination.md) of either `MessageView` or `DeletedMessageView` for each message in the conversation, as well
@@ -53,19 +53,58 @@ optionally the message id of the last message seen.
 To send a message to a conversation use `SendMessage()`:
 
 ```c#
-var sendMessageResult = await agent.SendMessage(conversationID, "hello"", cancellationToken);
+var sendMessageResult = await agent.SendMessage(conversationID, "hello");
 ```
 
 This returns a `MessageView` which includes the message identifier, which you can use to delete a message.
 
-For rich messages, tagging DIDs, embedding links etc. you can pass an instance of `MessageInput` and specify the facets for the message.
+If you want to embed a link to a post provide a `StrongReference` to the post in the optional `embeddedPost` parameter on `SendMessage`.
+
+Like posts mentions, hashtags and links are detected automatically. If you want to disable facet detection set the `extractFacets` parameter to false.
+If you want to create your own facets create an instance of `MessageInput` and pass that into `SendMessage`.
 
 You can send multiple messages into multiple conversations using `SendMessageBatch()`.
 
 ## <a name="deleting">Deleting a message in a conversation</a>
 
 To delete a message in a conversation use `DeleteMessageForSelf()`, passing the conversation id and the message id.
 
+## <a name="reacting">Embedded posts in messages</a>
+
+If you want to embed a link to a post provide a `StrongReference` to the post in the optional `embeddedPost` parameter on `SendMessage`.
+
+To extract the post details from a `MessageView` use the `Embed` property like this:
+
+```c#
+foreach (MessageViewBase message in getMessages.Result)
+{
+    if (message is MessageView view)
+    {
+        var sender = getConversation.Result.Members.FirstOrDefault(m => m.Did == view.Sender.Did) ??
+            throw new InvalidOperationException("Cannot find message sender in conversation view");
+
+        Console.WriteLine($"{sender}: {view.Text} {view.SentAt:g}");
+
+        if (view.Embed is not null &&
+            view.Embed.Record is not null &&
+            view.Embed.Record is ViewRecord viewRecord)
+        {
+            if (viewRecord.Value is Post post)
+            {
+                Console.WriteLine($"  {viewRecord.Author}");
+                Console.WriteLine($"  {post.Text}");
+            }
+        }
+    }
+    else if (message is DeletedMessageView _)
+    {
+        Console.WriteLine("Deleted Message");
+    }
+}
+```
+
+The above code leaves space for handling other types of embeds should they be added by Bluesky.
+
 ## <a name="reacting">Message reactions</a>
 
 Bluesky allows for simple message reactions in conversations. The `MessageView` you get from `getMessages` has a `Reactions` property which is a collection of `ReactionView`. To display reactions
@@ -105,10 +144,10 @@ To start a conversation you will need the DIDs of the conversation members, whic
 it will be restored in the direct message list.
 
 ```c#
-var memberDid = await agent.ResolveHandle("example.invalid.handle", cancellationToken);
+var memberDid = await agent.ResolveHandle("example.invalid.handle");
 List<Did> conversationMembers = new() { agent.Did!, bot2Did! };
 
-var startConversationResult = await agent.GetConversationForMembers(conversationMembers, cancellationToken);
+var startConversationResult = await agent.GetConversationForMembers(conversationMembers);
 ```
 
 `StartConversation()` returns a `ConversationView` which includes the conversation ID, which you can then use to send messages to the chat.

history.md

@@ -1,12 +1,21 @@
 # Version History
 
+## 0.9.5
+
+### Features
+
+#### idunno.Bluesky
+
+* Fix serialization exception in `SendMessage`. Fixes [#169](https://github.com/blowdart/idunno.Bluesky/issues/169)
+* Add optional parameter, `embeddedPost` to `SendMessage` to allow for embedding of posts in direct messages.
+
 ## 0.9.4
 
 ### Bug fixes
 
 #### idunno.Bluesky
 
-* Fix cursor pagination in GetFollowers, GetBlocks, GetFollows, GetKnownFollowers, GetListBlocks, GetListMutes, GetList, GetLists, ListConversations.
+* Fix cursor pagination in `GetFollowers`, `GetBlocks`, `GetFollows`, `GetKnownFollowers`, `GetListBlocks`, `GetListMutes`, `GetList`, `GetLists`, and `ListConversations`.
 
 ## 0.9.3
 

samples/Samples.DirectMessages/Program.cs

@@ -10,10 +10,12 @@
 
 using idunno.Bluesky;
 using idunno.Bluesky.Actor;
+using idunno.AtProto;
 using idunno.Bluesky.Chat;
 
 using Samples.Common;
-using idunno.AtProto;
+using idunno.Bluesky.Embed;
+using System.Net.Http.Headers;
 
 namespace Samples.DirectMessages
 {
@@ -102,6 +104,18 @@ static async Task PerformOperations(string? handle, string? password, string? au
                     }
                 }
 
+                var startConversationResult = await agent.GetConversationForMembers(["did:plc:hfgp6pj3akhqxntgqwramlbg"], cancellationToken: cancellationToken);
+                if (startConversationResult.Succeeded)
+                {
+                    var post = await agent.GetPostRecord("at://did:plc:hfgp6pj3akhqxntgqwramlbg/app.bsky.feed.post/3lqxyqocwx22m", cancellationToken: cancellationToken);
+
+                    var sendMessageResult = await agent.SendMessage(
+                        startConversationResult.Result.Id,
+                        "Embedded post test",
+                        embeddedPost: post.Result!.StrongReference,
+                        cancellationToken: cancellationToken);
+                }
+
                 var listConversations = await agent.ListConversations(cancellationToken: cancellationToken);
 
                 if (listConversations.Succeeded && listConversations.Result.Count != 0 && !cancellationToken.IsCancellationRequested)
@@ -179,6 +193,19 @@ static async Task PerformOperations(string? handle, string? password, string? au
                                                             throw new InvalidOperationException("Cannot find message sender in conversation view");
                                                         Console.WriteLine($"{reactionSender}: {reaction.Value} {reaction.CreatedAt:g}");
                                                     }
+
+                                                    if (view.Embed is not null &&
+                                                        view.Embed.Record is not null &&
+                                                        view.Embed.Record is ViewRecord viewRecord)
+                                                    {
+                                                        Console.WriteLine("  Embedded Record");
+
+                                                        if (viewRecord.Value is Post post)
+                                                        {
+                                                            Console.WriteLine($"  {viewRecord.Author}");
+                                                            Console.WriteLine($"  {post.Text}");
+                                                        }
+                                                    }
                                                 }
                                                 else if (message is DeletedMessageView _)
                                                 {

src/idunno.Bluesky/Chat/BlueskyAgent.cs

@@ -2,6 +2,7 @@
 // Licensed under the MIT License.
 
 using idunno.AtProto;
+using idunno.AtProto.Repo;
 using idunno.Bluesky.Chat;
 using idunno.Bluesky.RichText;
 
@@ -411,21 +412,30 @@ public async Task<AtProtoHttpResult<ICollection<MessageView>>> SendMessageBatch(
         /// <param name="id">The conversation identifier to send the <paramref name="message"/> to.</param>
         /// <param name="message">The message to send.</param>
         /// <param name="extractFacets">Flag indicating whether facets should be extracted from <paramref name="message" />.</param>
+        /// <param name="embeddedPost">A <see cref="StrongReference"/> to a post that will be embedded in the message.</param>
         /// <param name="cancellationToken">A cancellation token that can be used by other objects or threads to receive notice of cancellation.</param>
         /// <returns>The task object representing the asynchronous operation.</returns>
         /// <exception cref="ArgumentException">Thrown when <paramref name="id"/> is null or white space.</exception>
-        /// <exception cref="ArgumentNullException">Thrown when <paramref name="message"/> is null.</exception>
+        /// <exception cref="ArgumentNullException">Thrown when <paramref name="message"/> is null, or if <paramref name="embeddedPost"/> is specified but its collection is null.</exception>
+        /// <exception cref="ArgumentOutOfRangeException">Thrown when <paramref name="embeddedPost"/> is specified but it is not in the <see cref="CollectionNsid.Post"/> collection.</exception>
         /// <exception cref="AuthenticationRequiredException">Thrown when the current agent is not authenticated.</exception>
         public async Task<AtProtoHttpResult<MessageView>> SendMessage(
             string id,
             string message,
             bool extractFacets = true,
+            StrongReference? embeddedPost = null,
             CancellationToken cancellationToken = default)
         {
             ArgumentException.ThrowIfNullOrWhiteSpace(id);
 
             ArgumentNullException.ThrowIfNull(message);
 
+            if (embeddedPost is not null)
+            {
+                ArgumentNullException.ThrowIfNull(embeddedPost.Uri.Collection);
+                ArgumentOutOfRangeException.ThrowIfNotEqual(embeddedPost.Uri.Collection, CollectionNsid.Post);
+            }
+
             if (!IsAuthenticated)
             {
                 throw new AuthenticationRequiredException();
@@ -443,6 +453,11 @@ public async Task<AtProtoHttpResult<MessageView>> SendMessage(
                 messageInput = new MessageInput(message, facets);
             }
 
+            if (embeddedPost is not null)
+            {
+                messageInput.Embed = new Embed.EmbeddedRecord(embeddedPost);
+            }
+
             return await SendMessage(
                 id,
                 messageInput,

src/idunno.Bluesky/Chat/MessageInput.cs

@@ -28,7 +28,7 @@ public MessageInput(string text, ICollection<Facet>? facets = null, EmbeddedReco
 
             if (facets is not null)
             {
-                Facets = new ReadOnlyCollection<Facet>(facets.ToList<Facet>().AsReadOnly());
+                Facets = new ReadOnlyCollection<Facet>(facets.ToList().AsReadOnly());
             }
             else
             {
@@ -46,17 +46,17 @@ public MessageInput(string text, ICollection<Facet>? facets = null, EmbeddedReco
         public string Text { get; init; }
 
         /// <summary>
-        /// Gets the rich text <see cref="Facet"/>s of the message, if any.
+        /// Gets or sets the rich text <see cref="Facet"/>s of the message, if any.
         /// </summary>
         [JsonInclude]
         [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]
-        public IReadOnlyCollection<Facet>? Facets { get; init; }
+        public IReadOnlyCollection<Facet>? Facets { get; set; }
 
         /// <summary>
-        /// Gets the embedded record of the message, if any.
+        /// Gets or sets the embedded record of the message, if any.
         /// </summary>
         [JsonInclude]
         [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]
-        public EmbeddedRecord? Embed { get; init; }
+        public EmbeddedBase? Embed { get; set; }
     }
 }

src/idunno.Bluesky/Constants.cs

@@ -330,6 +330,16 @@ public static class EmbeddedRecordTypeDiscriminators
     /// </summary>
     public static class EmbeddedViewTypeDiscriminators
     {
+        /// <summary>
+        /// The json type discriminator for a view record.
+        /// </summary>
+        public const string ViewRecord = "app.bsky.embed.record#viewRecord";
+
+        /// <summary>
+        /// The json type discriminator for an view of an embedded record.
+        /// </summary>
+        public const string EmbedView = "app.bsky.embed.record#view";
+
         /// <summary>
         /// The json type discriminator for an view of an embedded record that cannot be found.
         /// </summary>
@@ -344,6 +354,27 @@ public static class EmbeddedViewTypeDiscriminators
         /// The json type discriminator for a view over a record that is detached
         /// </summary>
         public const string EmbedViewDetached = "app.bsky.embed.record#Detached";
+
+        /// <summary>
+        /// The json type discriminator for a view over a feed generator
+        /// </summary>
+        public const string GeneratorView = "app.bsky.feed.defs#generatorView";
+
+        /// <summary>
+        /// The json type discriminator for a view over a list
+        /// </summary>
+        public const string ListView = "app.bsky.graph.defs#listView";
+
+        /// <summary>
+        /// The json type discriminator for a view over a list
+        /// </summary>
+        public const string LabelerView = "app.bsky.labeler.defs#labelerView";
+
+        /// <summary>
+        /// The json type discriminator for a basic view over a starter pack
+        /// </summary>
+        public const string StarterPackViewBasic = "app.bsky.graph.defs#starterPackViewBasic";
+
     }
 
     /// <summary>

src/idunno.Bluesky/Embed/View.cs

@@ -6,9 +6,11 @@
 namespace idunno.Bluesky.Embed
 {
     /// <summary>
-    /// Base class for views over embedded records.
+    /// Json Polymorphic base class for embedded record views.
     /// </summary>
     [JsonPolymorphic(IgnoreUnrecognizedTypeDiscriminators = true, UnknownDerivedTypeHandling = JsonUnknownDerivedTypeHandling.FallBackToNearestAncestor)]
+    [JsonDerivedType(typeof(ViewRecord), typeDiscriminator: EmbeddedViewTypeDiscriminators.ViewRecord)]
+    [JsonDerivedType(typeof(EmbeddedView), typeDiscriminator: EmbeddedViewTypeDiscriminators.EmbedView)]
     [JsonDerivedType(typeof(ViewNotFound), typeDiscriminator: EmbeddedViewTypeDiscriminators.EmbedViewNotFound)]
     [JsonDerivedType(typeof(ViewBlocked), typeDiscriminator: EmbeddedViewTypeDiscriminators.EmbedViewBlocked)]
     [JsonDerivedType(typeof(ViewDetached), typeDiscriminator: EmbeddedViewTypeDiscriminators.EmbedViewDetached)]

src/idunno.Bluesky/Embed/ViewRecord.cs

@@ -10,6 +10,7 @@
 using idunno.AtProto.Repo;
 
 using idunno.Bluesky.Actor;
+using idunno.Bluesky.Record;
 
 namespace idunno.Bluesky.Embed
 {
@@ -27,6 +28,7 @@ public sealed record ViewRecord : View
         /// <param name="uri">The <see cref="AtUri"/> of the record.</param>
         /// <param name="cid">The <see cref="AtProto.Cid"/> of the record.</param>
         /// <param name="author">A <see cref="ProfileViewBasic"/> of the record author.</param>
+        /// <param name="value">A <see cref="BlueskyRecord"/>.</param>
         /// <param name="labels">Any labels applied to the record.</param>
         /// <param name="replyCount">The number of replies to this post.</param>
         /// <param name="repostCount">The number of times this post has been reposted.</param>
@@ -39,6 +41,7 @@ public ViewRecord(
             AtUri uri,
             Cid cid,
             ProfileViewBasic author,
+            BlueskyRecord value,
             IReadOnlyCollection<Label>? labels,
             int? replyCount,
             int? repostCount,
@@ -59,6 +62,8 @@ public ViewRecord(
             QuoteCount = quoteCount;
             Embeds = embeds ?? new List<EmbeddedView>().AsReadOnly();
             IndexedAt = indexedAt;
+
+            Value = value;
         }
 
         /// <summary>
@@ -89,16 +94,9 @@ public ViewRecord(
         public ProfileViewBasic Author { get; init; }
 
         /// <summary>
-        /// Gets the record data itself.
+        /// Gets the record itself.
         /// </summary>
-        [JsonIgnore]
-        public JsonElement Value
-        {
-            get
-            {
-                return ExtensionData["value"];
-            }
-        }
+        public BlueskyRecord Value { get; init; }
 
         /// <summary>
         /// Gets any labels applied to the record.

src/idunno.Bluesky/SourceGenerationContext.cs

@@ -88,6 +88,7 @@ namespace idunno.Bluesky
     [JsonSerializable(typeof(GetLogResponse))]
     [JsonSerializable(typeof(GetMessagesResponse))]
     [JsonSerializable(typeof(ListConversationsResponse))]
+    [JsonSerializable(typeof(SendMessageRequest))]
     [JsonSerializable(typeof(SendMessageBatchRequest))]
     [JsonSerializable(typeof(SendMessageBatchResponse))]
     [JsonSerializable(typeof(UpdateReadRequest))]

src/idunno.Bluesky/View.cs

@@ -11,6 +11,13 @@ namespace idunno.Bluesky
     /// Base class for view records.
     /// </summary>
     [JsonPolymorphic(IgnoreUnrecognizedTypeDiscriminators = true, UnknownDerivedTypeHandling = JsonUnknownDerivedTypeHandling.FallBackToNearestAncestor)]
+    [JsonDerivedType(typeof(Feed.GeneratorView), typeDiscriminator: EmbeddedViewTypeDiscriminators.GeneratorView)]
+    [JsonDerivedType(typeof(Graph.ListView), typeDiscriminator: EmbeddedViewTypeDiscriminators.ListView)]
+    [JsonDerivedType(typeof(Labeler.LabelerView), typeDiscriminator: EmbeddedViewTypeDiscriminators.LabelerView)]
+    [JsonDerivedType(typeof(Graph.StarterPackViewBasic), typeDiscriminator: EmbeddedViewTypeDiscriminators.StarterPackViewBasic)]
+    [JsonDerivedType(typeof(Embed.ViewRecord), typeDiscriminator: EmbeddedViewTypeDiscriminators.ViewRecord)]
+    [JsonDerivedType(typeof(Embed.EmbeddedView), typeDiscriminator: EmbeddedViewTypeDiscriminators.EmbedView)]
+
     public record View
     {
         /// <summary>