Merge pull request #451 from huankong233/main

对接口顺序和文档同步

src/onebot/action/types.ts

@@ -1,4 +1,4 @@
-export type BaseCheckResult = ValidCheckResult | InvalidCheckResult
+export type BaseCheckResult = ValidCheckResult | InvalidCheckResult;
 
 export interface ValidCheckResult {
     valid: true;
@@ -14,21 +14,93 @@ export interface InvalidCheckResult {
 }
 
 export enum ActionName {
+    // onebot 11
+    SendPrivateMsg = 'send_private_msg',
+    SendGroupMsg = 'send_group_msg',
+    SendMsg = 'send_msg',
+    DeleteMsg = 'delete_msg',
+    GetMsg = 'get_msg',
+    GoCQHTTP_GetForwardMsg = 'get_forward_msg',
+    SendLike = 'send_like',
+    SetGroupKick = 'set_group_kick',
+    SetGroupBan = 'set_group_ban',
+    // SetGroupAnoymousBan = 'set_group_anonymous_ban',
+    SetGroupWholeBan = 'set_group_whole_ban',
+    SetGroupAdmin = 'set_group_admin',
+    // SetGroupAnoymous = 'set_group_anonymous',
+    SetGroupCard = 'set_group_card',
+    SetGroupName = 'set_group_name',
+    SetGroupLeave = 'set_group_leave',
+    SetSpecialTittle = 'set_group_special_title',
+    SetFriendAddRequest = 'set_friend_add_request',
+    SetGroupAddRequest = 'set_group_add_request',
+    GetLoginInfo = 'get_login_info',
+    GoCQHTTP_GetStrangerInfo = 'get_stranger_info',
+    GetFriendList = 'get_friend_list',
+    GetGroupInfo = 'get_group_info',
+    GetGroupList = 'get_group_list',
+    GetGroupMemberInfo = 'get_group_member_info',
+    GetGroupMemberList = 'get_group_member_list',
+    GetGroupHonorInfo = 'get_group_honor_info',
+    GetCookies = 'get_cookies',
+    // GetCSRF = 'get_csrf_token',
+    // GetCredentials = 'get_credentials',
+    GetRecord = 'get_record',
+    GetImage = 'get_image',
+    CanSendImage = 'can_send_image',
+    CanSendRecord = 'can_send_record',
+    GetStatus = 'get_status',
+    GetVersionInfo = 'get_version_info',
+    // Reboot = 'set_restart',
+    // CleanCache = 'clean_cache',
+
+    // go-cqhttp
+    SetQQProfile = 'set_qq_profile',
+    // QidianGetAccountInfo = 'qidian_get_account_info',
+    // GetModelShow = '_get_model_show',
+    // SetModelShow = '_set_model_show',
+    // GetOnlineClient = 'get_online_clients',
+    // GetUnidirectionalFriendList = 'get_unidirectional_friend_list',
+    // DeleteFriend = 'delete_friend',
+    // DeleteUnidirectionalFriendList = 'delete_unidirectional_friend',
+    GoCQHTTP_MarkMsgAsRead = 'mark_msg_as_read',
+    GoCQHTTP_SendGroupForwardMsg = 'send_group_forward_msg',
+    GoCQHTTP_SendPrivateForwardMsg = 'send_private_forward_msg',
+    GoCQHTTP_GetGroupMsgHistory = 'get_group_msg_history',
+    OCRImage = 'ocr_image',
+    IOCRImage = '.ocr_image',
+    GetGroupSystemMsg = 'get_group_system_msg',
+    GoCQHTTP_GetEssenceMsg = 'get_essence_msg_list',
+    // GetGroupAtAllRemain = 'get_group_at_all_remain',
+    SetGroupPortrait = 'set_group_portrait',
+    SetEssenceMsg = 'set_essence_msg',
+    DelEssenceMsg = 'delete_essence_msg',
+    GoCQHTTP_SendGroupNotice = '_send_group_notice',
+    GoCQHTTP_GetGroupNotice = '_get_group_notice',
+    GoCQHTTP_UploadGroupFile = 'upload_group_file',
+    GOCQHTTP_DeleteGroupFile = 'delete_group_file',
+    GoCQHTTP_CreateGroupFileFolder = 'create_group_file_folder',
+    GoCQHTTP_DeleteGroupFileFolder = 'delete_group_folder',
+    GoCQHTTP_GetGroupFileSystemInfo = 'get_group_file_system_info',
+    GoCQHTTP_GetGroupRootFiles = 'get_group_root_files',
+    GoCQHTTP_GetGroupFilesByFolder = 'get_group_files_by_folder',
+    GOCQHTTP_GetGroupFileUrl = 'get_group_file_url',
+    GOCQHTTP_UploadPrivateFile = 'upload_private_file',
+    // GOCQHTTP_ReloadEventFilter = 'reload_event_filter',
+    GoCQHTTP_DownloadFile = 'download_file',
+    // GoCQHTTP_CheckUrlSafely = 'check_url_safely',
+    // GoCQHTTP_GetWordSlices = '.get_word_slices',
+    GoCQHTTP_HandleQuickAction = '.handle_quick_operation',
+
     // 以下为扩展napcat扩展
     Unknown = 'unknown',
-    GroupPoke = 'group_poke',
-    FriendPoke = 'friend_poke',
     SharePeer = 'ArkSharePeer',
     ShareGroupEx = 'ArkShareGroup',
-    RebootNormal = 'reboot_normal',//无快速登录重新启动
+    // RebootNormal = 'reboot_normal', //无快速登录重新启动
     GetRobotUinRange = 'get_robot_uin_range',
     SetOnlineStatus = 'set_online_status',
     GetFriendsWithCategory = 'get_friends_with_category',
-    GetGroupIgnoreAddRequest = 'get_group_ignore_add_request',
     SetQQAvatar = 'set_qq_avatar',
-    GetConfig = 'get_config',
-    SetConfig = 'set_config',
-    Debug = 'debug',
     GetFile = 'get_file',
     ForwardFriendSingleMsg = 'forward_friend_single_msg',
     ForwardGroupSingleMsg = 'forward_group_single_msg',
@@ -38,94 +110,37 @@ export enum ActionName {
     SetGroupFileFolder = 'set_group_file_folder',
     DelGroupFile = 'del_group_file',
     DelGroupFileFolder = 'del_group_file_folder',
-    // onebot 11
-    Reboot = 'set_restart',
-    SendLike = 'send_like',
-    GetLoginInfo = 'get_login_info',
-    GetFriendList = 'get_friend_list',
-    GetGroupInfo = 'get_group_info',
-    GetGroupList = 'get_group_list',
-    GetGroupMemberInfo = 'get_group_member_info',
-    GetGroupMemberList = 'get_group_member_list',
-    GetMsg = 'get_msg',
-    SendMsg = 'send_msg',
-    SendGroupMsg = 'send_group_msg',
-    SendPrivateMsg = 'send_private_msg',
-    DeleteMsg = 'delete_msg',
     SetMsgEmojiLike = 'set_msg_emoji_like',
-    SetGroupAddRequest = 'set_group_add_request',
-    SetFriendAddRequest = 'set_friend_add_request',
-    SetGroupLeave = 'set_group_leave',
-    GetVersionInfo = 'get_version_info',
-    GetStatus = 'get_status',
-    CanSendRecord = 'can_send_record',
-    CanSendImage = 'can_send_image',
-    SetGroupKick = 'set_group_kick',
-    SetGroupBan = 'set_group_ban',
-    SetGroupWholeBan = 'set_group_whole_ban',
-    SetGroupAdmin = 'set_group_admin',
-    SetGroupCard = 'set_group_card',
-    SetGroupName = 'set_group_name',
-    GetImage = 'get_image',
-    GetRecord = 'get_record',
-    CleanCache = 'clean_cache',
-    GetCookies = 'get_cookies',
-    // 以下为go-cqhttp api
-    GoCQHTTP_HandleQuickAction = '.handle_quick_operation',
-    GetGroupHonorInfo = 'get_group_honor_info',
-    GoCQHTTP_GetEssenceMsg = 'get_essence_msg_list',
-    GoCQHTTP_SendGroupNotice = '_send_group_notice',
-    GoCQHTTP_GetGroupNotice = '_get_group_notice',
     GoCQHTTP_SendForwardMsg = 'send_forward_msg',
-    GoCQHTTP_SendGroupForwardMsg = 'send_group_forward_msg',
-    GoCQHTTP_SendPrivateForwardMsg = 'send_private_forward_msg',
-    GoCQHTTP_GetStrangerInfo = 'get_stranger_info',
-    GoCQHTTP_MarkMsgAsRead = 'mark_msg_as_read',
-    GetGuildList = 'get_guild_list',
     MarkPrivateMsgAsRead = 'mark_private_msg_as_read',
     MarkGroupMsgAsRead = 'mark_group_msg_as_read',
-    GoCQHTTP_UploadGroupFile = 'upload_group_file',
-    GOCQHTTP_DeleteGroupFile = 'delete_group_file',
-    GOCQHTTP_GetGroupFileUrl = 'get_group_file_url',
-    GoCQHTTP_CreateGroupFileFolder = 'create_group_file_folder',
-    GoCQHTTP_DeleteGroupFileFolder = 'delete_group_file_folder',
-    GoCQHTTP_GetGroupFileSystemInfo = 'get_group_file_system_info',
-    GoCQHTTP_GetGroupRootFiles = 'get_group_root_files',
-    GoCQHTTP_GetGroupFilesByFolder = 'get_group_files_by_folder',
-    GoCQHTTP_DownloadFile = 'download_file',
-    GoCQHTTP_GetGroupMsgHistory = 'get_group_msg_history',
-    GoCQHTTP_GetForwardMsg = 'get_forward_msg',
     GetFriendMsgHistory = 'get_friend_msg_history',
-    GetGroupIgnoredNotifies = 'get_group_ignored_notifies',
-    GetOnlineClient = 'get_online_clients',
-    OCRImage = 'ocr_image',
-    IOCRImage = '.ocr_image',
-    SetQQProfile = 'set_qq_profile',
     CreateCollection = 'create_collection',
     GetCollectionList = 'get_collection_list',
     SetLongNick = 'set_self_longnick',
-    SetEssenceMsg = 'set_essence_msg',
-    DelEssenceMsg = 'delete_essence_msg',
     GetRecentContact = 'get_recent_contact',
     _MarkAllMsgAsRead = '_mark_all_as_read',
     GetProfileLike = 'get_profile_like',
-    SetGroupPortrait = 'set_group_portrait',
     FetchCustomFace = 'fetch_custom_face',
-    GOCQHTTP_UploadPrivateFile = 'upload_private_file',
-    TestApi01 = 'test_api_01',
     FetchEmojiLike = 'fetch_emoji_like',
-    GetGuildProfile = 'get_guild_service_profile',
-    SetModelShow = '_set_model_show',
     SetInputStatus = 'set_input_status',
-    GetCSRF = 'get_csrf_token',
+    GetGroupInfoEx = 'get_group_info_ex',
+    GetGroupIgnoredNotifies = 'get_group_ignored_notifies',
     DelGroupNotice = '_del_group_notice',
-    GetGroupInfoEx = "get_group_info_ex",
+    FetchUserProfileLike = 'fetch_user_profile_like',
-    GetGroupSystemMsg = 'get_group_system_msg',
+    FriendPoke = 'friend_poke',
-    FetchUserProfileLike = "fetch_user_profile_like",
+    GroupPoke = 'group_poke',
     GetPacketStatus = 'nc_get_packet_status',
-    GetUserStatus = "nc_get_user_status",
+    GetUserStatus = 'nc_get_user_status',
-    GetRkey = "nc_get_rkey",
+    GetRkey = 'nc_get_rkey',
-    SetSpecialTittle = "set_group_special_title",
+    GetGroupShutList = 'get_group_shut_list',
+
+    // GetGroupIgnoreAddRequest = 'get_group_ignore_add_request',
+    // GetConfig = 'get_config',
+    // SetConfig = 'set_config',
+    // Debug = 'debug',
+    // GetGuildList = 'get_guild_list',
+    // TestApi01 = 'test_api_01',
+    // GetGuildProfile = 'get_guild_service_profile',
     // UploadForwardMsg = "upload_forward_msg",
-    GetGroupShutList = "get_group_shut_list",
 }