napcat-sdk 0.5.0 → 0.6.0

package/dist/index.d.mts

@@ -6,7 +6,21 @@ declare const ABSTRACT_LOGGER: Logger;
 declare const CONSOLE_LOGGER: Logger;
 //#endregion
 //#region src/types.d.ts
-interface MiokiOptions {
+interface Stat {
+  /** 启动时间，Unix 时间戳（毫秒） */
+  start_time: number;
+  /** 已接受消息数 */
+  recv: {
+    group: number;
+    private: number;
+  };
+  /** 已发送消息数 */
+  send: {
+    group: number;
+    private: number;
+  };
+}
+interface NapcatOptions {
   /** NapCat 访问令牌 */
   token: string;
   /** NapCat 服务器协议，默认为 ws */
@@ -39,7 +53,7 @@ interface EventMap extends OneBotEventMap {
     app_name: string;
     app_version: string;
     protocol_version: string;
-    ts: number;
+    timestamp: number;
   };
 }
 /**
@@ -428,7 +442,7 @@ interface Group {
   /** NapCat 实例 */
   napcat: NapCat;
   /** 群签到 */
-  doSign: () => Promise<string>;
+  sign: () => Promise<string>;
   /** 获取群信息 */
   getInfo: () => Promise<{
     group_all_shut: number;
@@ -439,21 +453,21 @@ interface Group {
     max_member_count: number;
   }>;
   /** 获取群成员列表 */
-  getMemberList: () => Promise<any>;
+  getMemberList: () => Promise<GroupMemberInfo[]>;
   /** 获取群成员信息 */
-  getMemberInfo: (user_id: number) => Promise<any>;
+  getMemberInfo: (user_id: number) => Promise<GroupMemberInfo>;
   /** 设置群头衔 */
-  setTitle: (title: string) => Promise<any>;
+  setTitle: (user_id: number, title: string) => Promise<any>;
   /** 设置群名片 */
   setCard: (user_id: number, card: string) => Promise<any>;
-  /** 添加群精华消息 */
-  addEssence: (message_id: string) => Promise<any>;
-  /** 删除群精华消息 */
-  delEssence: (message_id: string) => Promise<any>;
+  /** 设置群精华消息 */
+  setEssence: (message_id: number) => Promise<any>;
+  /** 移除群精华消息 */
+  delEssence: (message_id: number) => Promise<any>;
   /** 撤回群消息 */
   recall: (message_id: number) => Promise<any>;
   /** 禁言群成员 */
-  banMember: (user_id: number, duration: number) => Promise<any>;
+  ban: (user_id: number, duration: number) => Promise<any>;
   /** 发送群消息 */
   sendMsg: SendMsg;
 }
@@ -581,7 +595,7 @@ type MessageEventBase<T extends MessageType, U$1 extends object> = EventBase<"me
   raw_message: string;
   /** 消息段数组 */
   message: RecvElement[];
-  /** 回复消息的方法 */
+  /** 回复消息 */
   reply: Reply;
 }>;
 /**
@@ -620,18 +634,20 @@ type GroupMessageEvent = MessageEventBase<"group", {
   user_id: number;
   /** 群消息子类型：normal-普通消息, notice-通知消息 */
   sub_type: "normal" | "notice";
-  /** 撤回该消息的方法 */
+  /** 撤回该消息 */
   recall: Recall;
-  /** 添加消息表态的方法 */
+  /** 添加消息表态 */
   addReaction: ReactionAction;
-  /** 删除消息表态的方法 */
+  /** 删除消息表态 */
   delReaction: ReactionAction;
   /** 获取引用的消息 */
   getQuoteMessage: () => Promise<GroupMessageEvent | null>;
-  /** 添加精华消息的方法 */
-  addEssence: () => Promise<void>;
-  /** 删除精华消息的方法 */
+  /** 设置精华消息 */
+  setEssence: () => Promise<void>;
+  /** 删除精华消息 */
   delEssence: () => Promise<void>;
+  /** 获取发送者作为群成员的相关信息，如群身份、群名片等 */
+  getSenderMemberInfo: () => Promise<any>;
   /** 群信息对象 */
   group: Group;
   /** 发送者信息 */
@@ -840,9 +856,9 @@ type RequestEventBase<T extends string, U$1 extends object> = EventBase<"request
 }>;
 /** 好友添加请求事件 */
 type FriendRequestEvent = RequestEventBase<"friend", {
-  /** 同意添加好友请求的方法 */
+  /** 同意添加好友请求 */
   approve: () => Promise<void>;
-  /** 拒绝添加好友请求的方法 */
+  /** 拒绝添加好友请求 */
   reject: (reason?: string) => Promise<void>;
 }>;
 /** 加群请求事件（他人申请加入群） */
@@ -851,9 +867,9 @@ type GroupAddRequestEvent = RequestEventBase<"group", {
   group_id: number;
   /** 请求子类型：add-主动加群 */
   sub_type: "add";
-  /** 同意群请求的方法 */
+  /** 同意群请求 */
   approve: () => Promise<void>;
-  /** 拒绝群请求的方法 */
+  /** 拒绝群请求 */
   reject: (reason?: string) => Promise<void>;
 }>;
 /** 邀请入群请求事件（他人邀请机器人入群） */
@@ -961,6 +977,26 @@ type OneBotAPI = "delete_friend" | "delete_msg" | "get_forward_msg" | "get_frien
 type NapCatExtendAPI = "_del_group_notice" | "_get_group_notice" | "_get_model_show" | "_mark_all_as_read" | "_send_group_notice" | "_set_model_show" | ".handle_quick_operation" | ".ocr_image" | "ArkShareGroup" | "ArkSharePeer" | "bot_exit" | "can_send_image" | "can_send_record" | "clean_cache" | "click_inline_keyboard_button" | "create_collection" | "create_group_file_folder" | "delete_essence_msg" | "delete_group_file" | "delete_group_folder" | "download_file" | "fetch_custom_face" | "fetch_emoji_like" | "forward_friend_single_msg" | "forward_group_single_msg" | "friend_poke" | "get_ai_characters" | "get_ai_record" | "get_clientkey" | "get_collection_list" | "get_cookies" | "get_credentials" | "get_csrf_token" | "get_doubt_friends_add_request" | "get_essence_msg_list" | "get_file" | "get_friend_msg_history" | "get_friends_with_category" | "get_group_at_all_remain" | "get_group_detail_info" | "get_group_file_system_info" | "get_group_file_url" | "get_group_files_by_folder" | "get_group_honor_info" | "get_group_ignored_notifies" | "get_group_info_ex" | "get_group_root_files" | "get_group_shut_list" | "get_group_system_msg" | "get_image" | "get_mini_app_ark" | "get_online_clients" | "get_private_file_url" | "get_profile_like" | "get_recent_contact" | "get_record" | "get_rkey_server" | "get_rkey" | "get_robot_uin_range" | "get_unidirectional_friend_list" | "get_version_info" | "group_poke" | "mark_group_msg_as_read" | "mark_msg_as_read" | "mark_private_msg_as_read" | "move_group_file" | "nc_get_packet_status" | "nc_get_rkey" | "nc_get_user_status" | "ocr_image" | "rename_group_file" | "send_forward_msg" | "send_group_ai_record" | "send_group_sign" | "send_like" | "send_packet" | "send_poke" | "set_diy_online_status" | "set_essence_msg" | "set_friend_remark" | "set_group_add_option" | "set_group_kick_members" | "set_group_remark" | "set_group_robot_add_option" | "set_group_search" | "set_group_sign" | "set_group_whole_ban" | "set_input_status" | "set_msg_emoji_like" | "set_online_status" | "set_qq_avatar" | "set_self_longnick" | "trans_group_file" | "translate_en2zh" | "upload_group_file" | "upload_private_file";
 /** 所有可用的 API 接口联合类型 */
 type API = OneBotAPI | NapCatExtendAPI;
+interface GroupMemberInfo {
+  group_id: number;
+  user_id: number;
+  nickname: string;
+  card: string;
+  sex: string;
+  age: number;
+  area: string;
+  level: string;
+  qq_level: number;
+  join_time: number;
+  last_sent_time: number;
+  title_expire_time: number;
+  unfriendly: boolean;
+  card_changeable: boolean;
+  is_robot: boolean;
+  shut_up_timestamp: number;
+  role: "owner" | "admin" | "member" | (string & {});
+  title: string;
+}
 //#endregion
 //#region src/segment.d.ts
 /**
@@ -1013,7 +1049,9 @@ declare const version: string;
 declare class NapCat {
   #private;
   private readonly options;
-  constructor(options: MiokiOptions);
+  constructor(options: NapcatOptions);
+  /** 统计数据 */
+  get stat(): Stat;
   /** WebSocket 实例 */
   get ws(): WebSocket;
   /** 日志记录器 */
@@ -1022,6 +1060,8 @@ declare class NapCat {
   get segment(): typeof segment;
   /**
   * 机器人 QQ 号
+  *
+  * @deprecated 建议使用 `uin` 属性
   */
   get user_id(): number;
   /**
@@ -1032,6 +1072,8 @@ declare class NapCat {
   * 机器人昵称
   */
   get nickname(): string;
+  /** 标准化可发送消息元素 */
+  normalizeSendable(msg: Sendable | Sendable[]): NormalizedElementToSend[];
   stringifyMessage(message: RecvElement[]): string;
   /** 获取一个群的信息，可以用于发送群消息等操作 */
   pickGroup(group_id: number): Promise<GroupWithInfo | null>;
@@ -1058,6 +1100,42 @@ declare class NapCat {
   */
   api<T extends any>(action: API | (string & {}), params?: Record<string, any>): Promise<T>;
   /**
+  * 获取好友列表
+  */
+  getFriendList(): Promise<(Friend & Record<string, any>)[]>;
+  /**
+  * 获取群列表
+  */
+  getGroupList(): Promise<(Group & Record<string, any>)[]>;
+  /**
+  * 添加消息回应
+  */
+  addReaction(message_id: number, id: string): Promise<void>;
+  /**
+  * 删除消息回应
+  */
+  delReaction(message_id: number, id: string): Promise<void>;
+  /**
+  * 获取消息
+  */
+  getMsg(message_id?: number | string | null): Promise<GroupMessageEvent | PrivateMessageEvent | null>;
+  /**
+  * 删除好友
+  */
+  deleteFriend(user_id: number, block?: boolean, both?: boolean): Promise<void>;
+  /**
+  * 设置群成员禁言
+  */
+  setGroupBan(group_id: number, user_id: number, duration: number): Promise<void>;
+  /**
+  * 撤回消息
+  */
+  recallMsg(message_id: number): Promise<void>;
+  /**
+  * 获取陌生人信息
+  */
+  getStrangerInfo(user_id: number): Promise<any>;
+  /**
   * 发送私聊消息
   */
   sendPrivateMsg(user_id: number, sendable: Sendable | Sendable[]): Promise<{
@@ -1070,6 +1148,38 @@ declare class NapCat {
     message_id: number;
   }>;
   /**
+  * 获取群信息
+  */
+  getGroupInfo(group_id: number): Promise<any>;
+  /**
+  * 群签到
+  */
+  setGroupSign(group_id: number): Promise<any>;
+  /**
+  * 设置群精华消息
+  */
+  setEssenceMsg(message_id: number): Promise<void>;
+  /**
+  * 删除群精华消息
+  */
+  deleteEssenceMsg(message_id: number): Promise<void>;
+  /**
+  * 设置群成员名片
+  */
+  setGroupCard(group_id: number, user_id: number, card: string): Promise<void>;
+  /**
+  * 设置群成员专属头衔
+  */
+  setGroupSpecialTitle(group_id: number, user_id: number, title: string): Promise<void>;
+  /**
+  * 获取群成员列表
+  */
+  getGroupMemberList(group_id: number): Promise<GroupMemberInfo[]>;
+  /**
+  * 获取群成员信息
+  */
+  getGroupMemberInfo(group_id: number, user_id: number): Promise<GroupMemberInfo>;
+  /**
   * 机器人是否在线
   */
   isOnline(): boolean;
@@ -1125,5 +1235,5 @@ declare class NapCat {
   close(): void;
 }
 //#endregion
-export { ABSTRACT_LOGGER, API, CONSOLE_LOGGER, EventBase, EventMap, ExtractByType, FlattenData, Friend, FriendDecreaseNoticeEvent, FriendIncreaseNoticeEvent, FriendInputNoticeEvent, FriendLikeNoticeEvent, FriendNoticeEvent, FriendNoticeEventBase, FriendPokeNoticeEvent, FriendRecallNoticeEvent, FriendRequestEvent, FriendWithInfo, Group, GroupAddRequestEvent, GroupAdminNoticeEvent, GroupBanNoticeEvent, GroupCardNoticeEvent, GroupDecreaseNoticeEvent, GroupEssenceNoticeEvent, GroupIncreaseNoticeEvent, GroupInviteRequestEvent, GroupMessageEvent, GroupNoticeEvent, GroupNoticeEventBase, GroupPokeNoticeEvent, GroupReactionNoticeEvent, GroupRecallNoticeEvent, GroupRequestEvent, GroupTitleNoticeEvent, GroupUploadNoticeEvent, GroupWithInfo, HeartbeatMetaEvent, LifecycleMetaEvent, LogLevel, Logger, MediaProps, MessageEvent, MessageEventBase, MessageType, MetaEvent, MetaEventBase, MetaEventType, MiokiOptions, NapCat, NapCatExtendAPI, NormalizedElementToSend, NoticeEvent, NoticeEventBase, NoticeSubType, NoticeType, OneBotAPI, OneBotEventMap, OptionalKeys, OptionalProps, PostType, PrivateMessageEvent, RecvAtElement, RecvDiceElement, RecvElement, RecvFaceElement, RecvFileElement, RecvForwardElement, RecvImageElement, RecvJsonElement, RecvLightAppElement, RecvLocationElement, RecvMarkdownElement, RecvPokeElement, RecvRecordElement, RecvReplyElement, RecvRpsElement, RecvShakeElement, RecvShareElement, RecvTextElement, RecvVideoElement, RequestEvent, RequestEventBase, SendAtElement, SendBfaceElement, SendContactElement, SendCustomMusicElement, SendElement, SendFaceElement, SendFileElement, SendForwardElement, SendImageElement, SendJsonElement, SendLightAppElement, SendMarkdownElement, SendMfaceElement, SendMusicElement, SendNodeContentElement, SendNodeElement, SendNodeRefElement, SendPlatformMusicElement, SendPokeElement, SendRecordElement, SendReplyElement, SendTextElement, SendVideoElement, Sendable, WrapData, name, noop, segment, version };
+export { ABSTRACT_LOGGER, API, CONSOLE_LOGGER, EventBase, EventMap, ExtractByType, FlattenData, Friend, FriendDecreaseNoticeEvent, FriendIncreaseNoticeEvent, FriendInputNoticeEvent, FriendLikeNoticeEvent, FriendNoticeEvent, FriendNoticeEventBase, FriendPokeNoticeEvent, FriendRecallNoticeEvent, FriendRequestEvent, FriendWithInfo, Group, GroupAddRequestEvent, GroupAdminNoticeEvent, GroupBanNoticeEvent, GroupCardNoticeEvent, GroupDecreaseNoticeEvent, GroupEssenceNoticeEvent, GroupIncreaseNoticeEvent, GroupInviteRequestEvent, GroupMemberInfo, GroupMessageEvent, GroupNoticeEvent, GroupNoticeEventBase, GroupPokeNoticeEvent, GroupReactionNoticeEvent, GroupRecallNoticeEvent, GroupRequestEvent, GroupTitleNoticeEvent, GroupUploadNoticeEvent, GroupWithInfo, HeartbeatMetaEvent, LifecycleMetaEvent, LogLevel, Logger, MediaProps, MessageEvent, MessageEventBase, MessageType, MetaEvent, MetaEventBase, MetaEventType, NapCat, NapCatExtendAPI, NapcatOptions, NormalizedElementToSend, NoticeEvent, NoticeEventBase, NoticeSubType, NoticeType, OneBotAPI, OneBotEventMap, OptionalKeys, OptionalProps, PostType, PrivateMessageEvent, RecvAtElement, RecvDiceElement, RecvElement, RecvFaceElement, RecvFileElement, RecvForwardElement, RecvImageElement, RecvJsonElement, RecvLightAppElement, RecvLocationElement, RecvMarkdownElement, RecvPokeElement, RecvRecordElement, RecvReplyElement, RecvRpsElement, RecvShakeElement, RecvShareElement, RecvTextElement, RecvVideoElement, RequestEvent, RequestEventBase, SendAtElement, SendBfaceElement, SendContactElement, SendCustomMusicElement, SendElement, SendFaceElement, SendFileElement, SendForwardElement, SendImageElement, SendJsonElement, SendLightAppElement, SendMarkdownElement, SendMfaceElement, SendMusicElement, SendNodeContentElement, SendNodeElement, SendNodeRefElement, SendPlatformMusicElement, SendPokeElement, SendRecordElement, SendReplyElement, SendTextElement, SendVideoElement, Sendable, Stat, WrapData, name, noop, segment, version };
 //# sourceMappingURL=index.d.mts.map