[Milky] Update README.md

Author: NoirHare

Lagrange.Milky/Api/Handlers/File/CreateGroupFolderHandler.cs

@@ -17,7 +17,7 @@ public async ValueTask<MilkyApiResponse<Result>> HandleAsync(Request request, Ca
         await _lagrange.GroupFSCreateFolder(request.GroupId, request.FolderName);
         return new MilkyApiResponse<Result>(new Result
         {
-            FolderId = "" // TODO: core no provide folder id
+            FolderId = "" // TODO: core did not provide a folder id
         });
     }
 

Lagrange.Milky/Api/Handlers/File/UploadGroupFileHandler.cs

@@ -25,7 +25,7 @@ public async ValueTask<MilkyApiResponse<Result>> HandleAsync(Request request, Ca
         ).WaitAsync(ct);
         return new MilkyApiResponse<Result>(new Result
         {
-            FileId = "" // TODO: core no provide file id
+            FileId = "" // TODO: core did not provide a folder id
         });
     }
 

Lagrange.Milky/Api/Handlers/Group/SendGroupMessageReactionHandler.cs

@@ -28,7 +28,7 @@ public sealed class Request(long groupId, long messageSeq, string reaction, stri
         [JsonPropertyName("group_id")] public required long GroupId { get; init; } = groupId;
         [JsonPropertyName("message_seq")] public required long MessageSeq { get; init; } = messageSeq;
         [JsonPropertyName("reaction")] public required string Reaction { get; init; } = reaction;
-        [JsonPropertyName("reaction_type")] public string ReactionType { get; init; } = reactionType; // TODO: reaction type not impl in core
+        [JsonPropertyName("reaction_type")] public string ReactionType { get; init; } = reactionType; // TODO: core does not implement reaction type
         [JsonPropertyName("is_add")] public bool IsAdd { get; init; } = isAdd;
     }
 }

Lagrange.Milky/Api/Handlers/Message/GetHistoryMessagesHandler.cs

@@ -24,7 +24,7 @@ public async ValueTask<MilkyApiResponse<Result>> HandleAsync(Request request, Ca
     {
         long endSequence = request.StartMessageSeq ?? request.MessageScene switch
         {
-            "friend" => throw new NotSupportedException(), // TODO: core cannot retrieve the latest sequence in a friend scene.
+            "friend" => throw new NotSupportedException(), // TODO: core will be unable to retrieve the latest sequence of friend.
             "group" => (await _lagrange.FetchGroupExtra(request.PeerId).WaitAsync(ct)).LatestMessageSequence,
             _ => throw new NotSupportedException(),
         };

Lagrange.Milky/Api/Handlers/System/GetCookiesHandler.cs

@@ -14,7 +14,6 @@ public partial class MilkyConverter
     {
         MessageType.Private => await ToFriendMessageAsync(message, ct),
         MessageType.Group => await ToGroupMessageAsync(message, ct),
-        MessageType.Temp => await ToTempMessageAsync(message, ct),
         _ => throw new NotSupportedException(),
     };
 
@@ -48,18 +47,4 @@ private async Task<GroupIncomingMessage> ToGroupMessageAsync(BotMessage message,
             GroupMember = ToGroupMember(member),
         };
     }
-
-    private async Task<TempIncomingMessage> ToTempMessageAsync(BotMessage message, CancellationToken ct = default)
-    {
-        long peerUin = message.Contact.Uin == _lagrange.BotUin ? message.Receiver.Uin : message.Contact.Uin;
-        return new TempIncomingMessage()
-        {
-            PeerId = peerUin,
-            MessageSeq = (long)message.Sequence,
-            SenderId = message.Contact.Uin,
-            Time = message.Time.ToUnixTimeSeconds(),
-            Segments = await ToIncomingSegmentsAsync(message.Entities, message.Type, peerUin, ct),
-            Group = null,
-        };
-    }
 }

Lagrange.Milky/Converters/MilkyConverter.Message.cs

@@ -4,14 +4,14 @@
 
 namespace Lagrange.Milky.Models.Messages;
 
-public sealed class IncomingForwardedMessage
-{
-    [JsonPropertyName("message_seq")] public required long MessageSeq { get; init; }
-    [JsonPropertyName("sender_name")] public required string SenderName { get; init; }
-    [JsonPropertyName("avatar_url")] public required string AvatarUrl { get; init; }
-    [JsonPropertyName("time")] public required long Time { get; init; }
-    [JsonPropertyName("segments")] public required IReadOnlyList<IncomingSegmentBase> Segments { get; init; }
-}
+// public sealed class IncomingForwardedMessage
+// {
+//     [JsonPropertyName("message_seq")] public required long MessageSeq { get; init; }
+//     [JsonPropertyName("sender_name")] public required string SenderName { get; init; }
+//     [JsonPropertyName("avatar_url")] public required string AvatarUrl { get; init; }
+//     [JsonPropertyName("time")] public required long Time { get; init; }
+//     [JsonPropertyName("segments")] public required IReadOnlyList<IncomingSegmentBase> Segments { get; init; }
+// }
 
 public sealed class OutgoingForwardedMessage
 {

Lagrange.Milky/Models/Messages/IncomingForwardedMessage.cs

@@ -7,7 +7,6 @@ namespace Lagrange.Milky.Models.Messages;
 [JsonPolymorphic(TypeDiscriminatorPropertyName = "message_scene")]
 [JsonDerivedType(typeof(FriendIncomingMessage), "friend")]
 [JsonDerivedType(typeof(GroupIncomingMessage), "group")]
-[JsonDerivedType(typeof(TempIncomingMessage), "temp")]
 public abstract class IncomingMessageBase
 {
     [JsonPropertyName("peer_id")] public required long PeerId { get; init; }

Lagrange.Milky/Models/Messages/IncomingMessageBase.cs

@@ -10,6 +10,16 @@ _[Milky](https://github.com/SaltifyDev/milky) protocol implementation based on [
 
 https://lagrangedev.github.io/Lagrange.Milky.Document
 
+## Contribute
+
+### api
+
+Write an implementation of `IApiHandler<TRequest, TResult>`/`INoRequestApiHandler<TResult>`/`INoResultApiHandler<TRequest>` in the folder corresponding to the `Lagrange.Milky\Api\Handlers` category, and add `TRequest` and `TResult` to the collection of `[JsonSerializable]` attributes above `JsonContext` in `Lagrange.Milky\Serialization\Serializer.cs`.
+
+### event
+
+Write an implementation of `IEventConverter<TEvent, TData>` in `Lagrange.Milky\Events\Converters`, and add `TData` to the `[JsonSerializable]` attributes above `JsonContext` in `Lagrange.Milky\Serialization\Serializer.cs`.
+
 ## Feature List
 
 - Api
@@ -21,7 +31,94 @@ https://lagrangedev.github.io/Lagrange.Milky.Document
 
 ### api
 
-No APIs have been implemented.
+#### system
+
+[x] get_login_info
+[x] get_impl_info
+[x] get_user_profile
+[x] get_friend_list
+[x] get_friend_info
+[x] get_group_list
+[x] get_group_info
+[x] get_group_member_list
+[x] get_group_member_info
+[ ] get_peer_pins
+[x] set_peer_pin
+[x] set_avatar
+[ ] set_nickname
+[ ] set_bio
+[ ] get_custom_face_url_list
+[x] get_cookies
+[ ] get_csrf_token
+
+#### message
+
+[x] send_private_message
+[x] send_group_message
+[x] recall_private_message
+[x] recall_group_message
+[x] get_message
+[x] get_history_messages
+  - request
+    - [ ] start_message_seq - When message_scene is friend, start_message_seq cannot be null, otherwise the core will be unable to retrieve the latest sequence of friend.
+[x] get_resource_temp_url
+[ ] get_forwarded_messages
+[ ] mark_message_as_read
+
+#### friend
+
+[x] send_friend_nudge
+[ ] send_profile_like
+[ ] delete_friend
+[ ] get_friend_requests
+[ ] accept_friend_request
+[ ] reject_friend_request
+
+#### group
+
+[x] set_group_name
+[ ] set_group_avatar
+[x] set_group_member_card
+[x] set_group_member_special_title
+[ ] set_group_member_admin
+[ ] set_group_member_mute
+[x] set_group_whole_mute
+[x] kick_group_member
+[ ] get_group_announcements
+[ ] send_group_announcement
+[ ] delete_group_announcement
+[ ] get_group_essence_messages
+[x] set_group_essence_message
+[x] quit_group
+[x] send_group_message_reaction
+  - result
+    - reaction_type - core does not implement reaction type
+[x] send_group_nudge
+[x] get_group_notifications
+[x] accept_group_request
+[x] reject_group_request
+[x] accept_group_invitation
+[x] reject_group_invitation
+
+#### file
+
+[x] upload_private_file
+  - result
+    - [ ] file_id
+[x] upload_group_file
+  - result
+    - [ ] file_id - core did not provide a folder id
+[ ] get_private_file_download_url
+[x] get_group_file_download_url
+[x] get_group_files
+[x] move_group_file
+[ ] rename_group_file
+[x] delete_group_file
+[x] create_group_folder
+  - result
+    - [ ] file_id - core did not provide a folder id
+[x] rename_group_folder
+[x] delete_group_folder
 
 ### event
 
@@ -54,25 +151,18 @@ No APIs have been implemented.
 - [x] Group
 - [x] GroupMember
 - [ ] GroupAnnouncement
-- [ ] GroupFile
-- [ ] GroupFolder
+- [x] GroupFile
+- [x] GroupFolder
 - [ ] FriendRequest
-- [ ] GroupNotification
-  - [ ] join_request
-  - [ ] admin_change
-  - [ ] kick
-  - [ ] quit
-  - [ ] invited_join_request
+- [x] GroupNotification
 - [x] IncomingMessage
   - [x] friend
   - [x] group
-  - [x] temp
-    - [ ] group - It will only return null
 - [ ] IncomingForwardedMessage
 - [ ] GroupEssenceMessage
 - [x] [IncomingSegment](#imcoming-segment)
-- [ ] OutgoingForwardedMessage
-- [ ] [OutgoingSegment](#outgoing-segment)
+- [x] OutgoingForwardedMessage
+- [x] [OutgoingSegment](#outgoing-segment)
 
 ### imcoming segment
 
@@ -93,6 +183,19 @@ No APIs have been implemented.
 - [x] light_app
 - [ ] xml
 
-### imcoming forward segment
+### outgoing segment
 
-### outgoing segment
+- [x] text
+- [x] mention
+- [x] mention_all
+- [ ] face
+- [x] reply
+- [x] image
+- [x] record
+- [x] video
+- [x] forward
+  - [ ] title
+  - [ ] preview
+  - [ ] summary
+  - [ ] prompt
+- [x] light_app