node-karin 0.0.3

package/lib/adapter/onebot/onebot11.d.ts

@@ -0,0 +1,430 @@
+/// <reference types="node" />
+import WebSocket from 'ws';
+import { IncomingMessage } from 'http';
+import { KarinAdapter } from '../../types/adapter.js';
+import { CustomNodeSegment, OneBot11Api, OneBot11ApiParamsType, OneBot11Segment } from '../../types/onebots11.js';
+import { Scene, contact } from '../../types/types.js';
+import { KarinElement } from '../../types/element.js';
+/**
+ * @class OneBot11
+ * @extends KarinAdapter
+ */
+export declare class OneBot11 implements KarinAdapter {
+    #private;
+    /**
+     * 机器人QQ号
+     */
+    self_id: string;
+    /**
+     * - 重连次数 仅正向ws使用
+     */
+    index: number;
+    socket: WebSocket;
+    account: KarinAdapter['account'];
+    adapter: KarinAdapter['adapter'];
+    version: KarinAdapter['version'];
+    constructor();
+    /**
+     * 反向ws初始化
+     */
+    server(socket: WebSocket, request: IncomingMessage): Promise<void>;
+    /**
+     * 正向ws初始化
+     * @param connect - WebSocket连接地址
+     */
+    client(connect: string): Promise<void>;
+    /**
+     * 获取当前登录号信息
+     */
+    getSelf(): Promise<void>;
+    /** 是否初始化 */
+    get isInit(): Promise<unknown>;
+    /**
+     * onebot11转karin
+     * @param {Array<{type: string, data: any}>} data onebot11格式消息
+     * @return karin格式消息
+     * */
+    AdapterConvertKarin(data: Array<OneBot11Segment>): (import("../../types/element.js").TextElement | import("../../types/element.js").AtElement | import("../../types/element.js").FaceElement | import("../../types/element.js").ReplyElement | import("../../types/element.js").ImageElement | import("../../types/element.js").VoiceElement | import("../../types/element.js").VideoElement | import("../../types/element.js").PokeElement | import("../../types/element.js").LocationElement | import("../../types/element.js").ForwardElement | import("../../types/element.js").ContactElement | import("../../types/element.js").JsonElement | import("../../types/element.js").XmlElement)[];
+    /**
+     * karin转onebot11
+     * @param data karin格式消息
+     * @return {Array<{type: string, data: any}>} onebot11格式消息
+     * */
+    KarinConvertAdapter(data: Array<KarinElement>): (import("../../types/element.js").BubbleFaceElement | import("../../types/element.js").RecordElement | import("../../types/element.js").BasketballElement | import("../../types/element.js").DiceElement | import("../../types/element.js").RpsElement | import("../../types/element.js").WeatherElement | import("../../types/element.js").LocationElement | import("../../types/element.js").ShareElement | import("../../types/element.js").GiftElement | import("../../types/element.js").MarketFaceElement | import("../../types/element.js").ContactElement | import("../../types/element.js").RowElement | import("../../types/element.js").LongMsgElement | {
+        type: string;
+        data: {
+            text: string;
+            id?: undefined;
+            qq?: undefined;
+            file?: undefined;
+            data?: undefined;
+            magic?: undefined;
+            type?: undefined;
+        };
+    } | {
+        type: string;
+        data: {
+            id: number;
+            text?: undefined;
+            qq?: undefined;
+            file?: undefined;
+            data?: undefined;
+            magic?: undefined;
+            type?: undefined;
+        };
+    } | {
+        type: string;
+        data: {
+            qq: string;
+            text?: undefined;
+            id?: undefined;
+            file?: undefined;
+            data?: undefined;
+            magic?: undefined;
+            type?: undefined;
+        };
+    } | {
+        type: string;
+        data: {
+            id: string;
+            text?: undefined;
+            qq?: undefined;
+            file?: undefined;
+            data?: undefined;
+            magic?: undefined;
+            type?: undefined;
+        };
+    } | {
+        type: "file" | "video" | "image";
+        data: {
+            file: string;
+            text?: undefined;
+            id?: undefined;
+            qq?: undefined;
+            data?: undefined;
+            magic?: undefined;
+            type?: undefined;
+        };
+    } | {
+        type: "json" | "xml";
+        data: {
+            data: string;
+            text?: undefined;
+            id?: undefined;
+            qq?: undefined;
+            file?: undefined;
+            magic?: undefined;
+            type?: undefined;
+        };
+    } | {
+        type: string;
+        data: {
+            file: string;
+            magic: boolean;
+            text?: undefined;
+            id?: undefined;
+            qq?: undefined;
+            data?: undefined;
+            type?: undefined;
+        };
+    } | {
+        type: "markdown";
+        data: {
+            content: string;
+            custom_template_id: string;
+            params: {
+                key: string;
+                values: string[];
+            }[];
+            text?: undefined;
+            id?: undefined;
+            qq?: undefined;
+            file?: undefined;
+            data?: undefined;
+            magic?: undefined;
+            type?: undefined;
+        };
+    } | {
+        type: string;
+        data: {
+            type: number;
+            id: number;
+            text?: undefined;
+            qq?: undefined;
+            file?: undefined;
+            data?: undefined;
+            magic?: undefined;
+        };
+    })[];
+    /**
+     * 专属当前Bot的日志打印方法
+     */
+    logger(level: 'info' | 'error' | 'trace' | 'debug' | 'mark' | 'warn' | 'fatal', ...args: any[]): void;
+    /**
+     * 获取头像url
+     * @param 头像大小，默认`0`
+     * @param 用户qq，默认为机器人QQ
+     * @returns 头像的url地址
+     */
+    getAvatarUrl(uid?: string, size?: number): string;
+    /**
+     * 获取群头像
+     * @param group_id - 群号
+     * @param size - 头像大小，默认`0`
+     * @param history - 历史头像记录，默认`0`，若要获取历史群头像则填写1,2,3...
+     * @returns - 群头像的url地址
+     */
+    getGroupAvatar(group_id: string, size?: number, history?: number): string;
+    /**
+     * 发送私聊消息
+     * @param user_id - 用户ID
+     * @param message - 要发送的内容
+     * @returns - 消息ID
+     */
+    send_private_msg(user_id: string, message: Array<KarinElement>): Promise<{
+        message_id?: string;
+    }>;
+    /**
+     * 发送群消息
+     * @param group_id - 群号
+     * @param message - 要发送的内容
+     * @returns - 消息ID
+     */
+    send_group_msg(group_id: string, message: Array<KarinElement>): Promise<any>;
+    /**
+     * 发送消息
+     *
+     * @param contact
+     * @param elements
+     * @returns - 消息ID
+     */
+    SendMessage(contact: contact, elements: Array<KarinElement>): Promise<any>;
+    /**
+     * 上传合并转发消息
+     * @param contact - 联系人信息
+     * @param elements - nodes
+     * @returns - 资源id
+     * */
+    UploadForwardMessage(contact: {
+        scene: Scene;
+        peer: string;
+    }, elements: any[]): Promise<any>;
+    /**
+     * 通过资源id发送转发消息
+     * @param contact - 联系人信息
+     * @param id - 资源id
+     * */
+    SendMessageByResId(contact: {
+        scene: Scene;
+        peer: string;
+    }, id: any): Promise<{
+        message_id: any;
+        message_time: number;
+    }>;
+    /**
+     * 撤回消息
+     * @param {null} [_contact] - ob11无需提供contact参数
+     * @param message_id - 消息ID
+     * @returns {Promise<null>}
+     */
+    RecallMessage(_contact: contact, message_id: string): Promise<any>;
+    /**
+     * 获取消息
+     * @param {null} [_contact] - ob11无需提供contact参数
+     * @param message_id - 消息ID
+     * @returns {Promise<object>} - 消息内容
+     */
+    GetMessage(_contact: any, message_id: any): Promise<any>;
+    /**
+     * 获取msg_id获取历史消息
+     * @description 此api各平台实现不同，暂时废弃
+     */
+    GetHistoryMessage(contact: contact, start_message_id: string, count?: number): Promise<{
+        time: any;
+        message_id: any;
+        message_seq: any;
+        contact: contact;
+        sender: any;
+        elements: (import("../../types/element.js").TextElement | import("../../types/element.js").AtElement | import("../../types/element.js").FaceElement | import("../../types/element.js").ReplyElement | import("../../types/element.js").ImageElement | import("../../types/element.js").VoiceElement | import("../../types/element.js").VideoElement | import("../../types/element.js").PokeElement | import("../../types/element.js").LocationElement | import("../../types/element.js").ForwardElement | import("../../types/element.js").ContactElement | import("../../types/element.js").JsonElement | import("../../types/element.js").XmlElement)[];
+    }[]>;
+    /**
+     * 获取合并转发消息
+     */
+    get_forward_msg(id: string): Promise<Array<CustomNodeSegment>>;
+    /**
+     * 发送好友赞
+     * @param target_uid_or_uin - 用户ID
+     * @param vote_count - 赞的次数，默认为`10`
+     */
+    VoteUser(target_uid_or_uin: string, vote_count?: number): Promise<void>;
+    /**
+     * 群组踢人
+     */
+    KickMember(group_id: string, target_uid_or_uin: string, reject_add_request?: boolean, kick_reason?: string): Promise<void>;
+    /**
+     * 禁言用户
+     * @param group_id - 群号
+     * @param target_uid_or_uin - 用户ID
+     * @param duration - 禁言时长，单位秒，0 表示取消禁言
+     */
+    BanMember(group_id: string, target_uid_or_uin: string, duration: number): Promise<void>;
+    /**
+     * 群组全员禁言
+     * @param group_id - 群号
+     * @param enable - 是否全员禁言
+     */
+    SetGroupWholeBan(group_id: string, enable?: boolean): Promise<void>;
+    /**
+     * 设置群管理员
+     * @param {{
+     *  group_id:string,
+     *  target_uid?:string,
+     *  target_uin?:string,
+     *  is_admin:boolean
+     * }} options - 设置管理员选项
+     * @param options.group_id - 群组ID
+     * @param options.target_uid - 要设置为管理员的用户uid
+     * @param options.target_uin - 要设置为管理员的用户uin
+     * @param options.is_admin - 是否设置为管理员
+     * @returns {Promise<SetGroupAdminResponse>} - 设置群管理员操作的响应
+     */
+    SetGroupAdmin(group_id: string, target_uid_or_uin: string, is_admin: boolean): Promise<void>;
+    /**
+     * 群组匿名
+     * @param group_id - 群号
+     * @param enable - 是否允许匿名聊天
+     */
+    set_group_anonymous(group_id: string, enable?: boolean): Promise<void>;
+    /**
+     * 修改群名片
+     * @param group_id - 群号
+     * @param target_uid_or_uin - 目标用户ID
+     * @param card - 新名片
+     */
+    ModifyMemberCard(group_id: string, target_uid_or_uin: string, card: string): Promise<void>;
+    /**
+     * 设置群名
+     * @param group_id - 群号
+     * @param group_name - 新群名
+     */
+    ModifyGroupName(group_id: string, group_name: string): Promise<void>;
+    /**
+     * 退出群组
+     * @param group_id - 群号
+     * @param is_dismiss - 是否解散，如果登录号是群主，则仅在此项为 true 时能够解散
+     */
+    LeaveGroup(group_id: string, is_dismiss?: boolean): Promise<void>;
+    /**
+     * 设置群专属头衔
+     * @param group_id - 群号
+     * @param target_uid_or_uin - 目标用户ID
+     * @param special_title - 专属头衔
+     */
+    SetGroupUniqueTitle(group_id: string, target_uid_or_uin: string, unique_title: string): Promise<void>;
+    /**
+     * 获取登录号信息
+     */
+    GetCurrentAccount(): Promise<{
+        account_uid: string;
+        account_uin: string;
+        account_name: string;
+    }>;
+    /**
+     * 获取陌生人信息 不支持批量获取 只支持一个
+     * @param target_uid_or_uin - 目标用户ID
+     */
+    GetStrangerProfileCard(target_uid_or_uin: Array<string>): Promise<any[]>;
+    /**
+     * 获取好友列表
+     * @returns {Promise<Array<IFriendInfo>>} - 好友列表
+     */
+    GetFriendList(): Promise<any>;
+    /**
+     * 获取群信息
+     * @param group_id - 群号
+     * @param no_cache - 是否不使用缓存
+     * @returns {Promise<IGroupInfo>} - 群信息
+     */
+    GetGroupInfo(group_id: string, no_cache?: boolean): Promise<{
+        group_id: any;
+        group_name: any;
+        group_remark: any;
+        max_member_count: any;
+        member_count: any;
+        group_uin: any;
+        admins: any;
+        owner: any;
+    }>;
+    /**
+     * 获取群列表
+     */
+    GetGroupList(): Promise<any>;
+    /**
+     * 获取群成员信息
+     * @param group_id - 群号
+     * @param target_uid_or_uin - 目标用户ID
+     * @param refresh - 是否刷新缓存，默认为 false
+     */
+    GetGroupMemberInfo(group_id: string, target_uid_or_uin: string, refresh?: boolean): Promise<{
+        uid: any;
+        uin: any;
+        nick: any;
+        age: any;
+        unique_title: any;
+        unique_title_expire_time: any;
+        card: any;
+        join_time: any;
+        last_active_time: any;
+        shut_up_time: number;
+        level: number;
+        shut_up_timestamp: any;
+        unfriendly: any;
+        card_changeable: any;
+    }>;
+    /**
+     * 获取群成员列表
+     * @param group_id - 群号
+     * @param refresh - 是否刷新缓存，默认为 false
+     */
+    GetGroupMemberList(group_id: string, refresh?: boolean): Promise<any>;
+    /**
+     * 获取群荣誉信息
+     */
+    GetGroupHonor(group_id: string, refresh?: boolean): Promise<{
+        uin: string;
+        uid: string;
+        nick: string;
+        honor_name: string;
+        avatar: string;
+        id: number;
+        description: string;
+    }[]>;
+    /**
+     * 获取版本信息
+     */
+    GetVersion(): Promise<any>;
+    DownloadForwardMessage(): Promise<void>;
+    GetEssenceMessageList(): Promise<void>;
+    SetEssenceMessage(): Promise<void>;
+    DeleteEssenceMessage(): Promise<void>;
+    SetFriendApplyResult(): Promise<void>;
+    SetGroupApplyResultRequest(): Promise<void>;
+    SetInvitedJoinGroupResult(): Promise<void>;
+    ReactMessageWithEmojiRequest(): Promise<void>;
+    UploadPrivateFile(): Promise<void>;
+    UploadGroupFile(): Promise<void>;
+    sendForwardMessage(): Promise<{}>;
+    /**
+     * 发送API请求
+     * @param action - API断点
+     * @param {object} params - API参数
+     * @returns {Promise<any>} - API返回
+     */
+    SendApi(action: OneBot11Api, params?: OneBot11ApiParamsType[OneBot11Api], time?: number): Promise<any>;
+}
+declare const _default: {
+    type: string;
+    path: string;
+    adapter: typeof OneBot11;
+};
+export default _default;