node-karin 0.12.0 → 0.12.2-5.pr.206.027f2f2

package/lib/adapter/onebot/11/index.d.ts

@@ -1,508 +0,0 @@
-import WebSocket from 'ws';
-import { IncomingMessage } from 'http';
-import { GroupHonorInfo, KarinAdapter, LoggerLevel, OB11ApiParams, OB11ApiResponse, OB11Segment, Role } from '../../../types/index.js';
-import { Scene, Contact, KarinElement, OB11EventAll, GroupInfo, NodeElement, EssenceMessageBody } from '../../../types/index.js';
-/**
- * @class OneBot11
- * @extends KarinAdapter
- */
-export declare class AdapterOneBot11 implements KarinAdapter {
-    #private;
-    /**
-     * - 重连次数 仅正向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>;
-    init(data: OB11EventAll): boolean;
-    get self_id(): string;
-    /**
-     * 获取当前登录号信息
-     */
-    getSelf(): Promise<void>;
-    /**
-     * onebot11转karin
-     * @return karin格式消息
-     */
-    AdapterConvertKarin(data: Array<OB11Segment>): KarinElement[];
-    /**
-     * karin转onebot11
-     * @param data karin格式消息
-     */
-    KarinConvertAdapter(data: Array<KarinElement>): OB11Segment[];
-    /**
-     * 专属当前Bot的日志打印方法
-     */
-    logger(level: LoggerLevel, ...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地址
-     */
-    getGroupAvatarUrl(group_id: string, size?: number, history?: number): string;
-    /**
-     * 发送消息
-     *
-     * @param contact
-     * @param elements
-     * @returns - 消息ID
-     */
-    SendMessage(contact: Contact, elements: Array<KarinElement>): Promise<{
-        message_id: string;
-        message_time: number;
-    }>;
-    /**
-     * 上传合并转发消息
-     * @param contact - 联系人信息
-     * @param elements - nodes
-     * @returns - 资源id
-     */
-    UploadForwardMessage(contact: Contact, elements: NodeElement[]): Promise<string>;
-    /**
-     * 通过资源id发送转发消息
-     * @param contact - 联系人信息
-     * @param id - 资源id
-     */
-    SendMessageByResId(contact: Contact, id: string): Promise<{
-        message_id: string;
-        message_time: number;
-    }>;
-    /**
-     * 撤回消息
-     * @param _contact - ob11无需提供contact参数
-     * @param message_id - 消息ID
-     */
-    RecallMessage(_contact: Contact, message_id: string): Promise<boolean>;
-    /**
-     * 获取消息
-     * @param contact - 联系人信息
-     * @param message_id - 消息ID
-     */
-    GetMessage(contact: Contact, message_id: string): Promise<{
-        time: number;
-        message_id: string;
-        message_seq: number;
-        contact: {
-            scene: Scene;
-            peer: string;
-        };
-        sender: {
-            uid: string;
-            uin: string;
-            nick: string;
-            role: Role;
-        };
-        elements: KarinElement[];
-    }>;
-    /**
-     * 获取msg_id获取历史消息
-     * @description 此api各平台实现不同
-     */
-    GetHistoryMessage(contact: Contact, start_message_id: string, count?: number): Promise<{
-        time: number;
-        message_id: string;
-        message_seq: number;
-        contact: {
-            scene: Scene;
-            peer: string;
-            sub_peer: string;
-        };
-        sender: {
-            uid: string;
-            uin: string;
-            nick: string;
-            role: Role;
-        };
-        elements: KarinElement[];
-    }[]>;
-    /**
-     * 发送好友赞
-     * @param target_uid_or_uin - 用户ID
-     * @param vote_count - 赞的次数，默认为`10`
-     */
-    VoteUser(target_uid_or_uin: string, vote_count?: number): Promise<boolean>;
-    /**
-     * 群组踢人
-     */
-    KickMember(group_id: string, target_uid_or_uin: string, reject_add_request?: boolean, kick_reason?: string): Promise<boolean>;
-    /**
-     * 禁言用户
-     * @param group_id - 群号
-     * @param target_uid_or_uin - 用户ID
-     * @param duration - 禁言时长，单位秒，0 表示取消禁言
-     */
-    BanMember(group_id: string, target_uid_or_uin: string, duration: number): Promise<boolean>;
-    /**
-     * 群组全员禁言
-     * @param group_id - 群号
-     * @param is_ban - 是否全员禁言
-     */
-    SetGroupWholeBan(group_id: string, is_ban?: boolean): Promise<boolean>;
-    /**
-     * 设置群管理员
-     * @param group_id - 群号
-     * @param target_uid_or_uin - 目标用户ID
-     * @param is_admin - 是否设置为管理员
-     */
-    SetGroupAdmin(group_id: string, target_uid_or_uin: string, is_admin: boolean): Promise<boolean>;
-    /**
-     * 修改群名片
-     * @param group_id - 群号
-     * @param target_uid_or_uin - 目标用户ID
-     * @param card - 新名片
-     */
-    ModifyMemberCard(group_id: string, target_uid_or_uin: string, card: string): Promise<boolean>;
-    /**
-     * 设置群名
-     * @param group_id - 群号
-     * @param group_name - 新群名
-     */
-    ModifyGroupName(group_id: string, group_name: string): Promise<boolean>;
-    /**
-     * 退出群组
-     * @param group_id - 群号
-     * @param is_dismiss - 是否解散，如果登录号是群主，则仅在此项为 true 时能够解散
-     */
-    LeaveGroup(group_id: string, is_dismiss?: boolean): Promise<false | undefined>;
-    /**
-     * 设置群专属头衔
-     * @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<false | undefined>;
-    /**
-     * 获取登录号信息
-     */
-    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<{
-        /**
-         * - 用户UID
-         */
-        uid: string;
-        /**
-       * - 用户UIN
-       */
-        uin: string;
-        /**
-       * - qid
-       */
-        qid: string;
-        /**
-       * - 名称
-       */
-        nick: string;
-        /**
-       * - 备注
-       */
-        remark: string;
-        /**
-       * - 用户等级
-       */
-        level: number;
-        /**
-       * - 生日
-       */
-        birthday: string;
-        /**
-       * - 登录天数
-       */
-        login_day: number;
-        /**
-       * - 点赞数
-       */
-        vote_cnt: number;
-        /**
-       * - 学校是否已核实
-       */
-        is_school_verified: undefined;
-        /**
-       * - 年龄
-       * - 拓展字段
-       */
-        age: number;
-        /**
-       * - 性别
-       * - 拓展字段
-       */
-        sex: "unknown" | "male" | "female";
-        ext: {
-            /**
-             * 大会员
-             */
-            big_vip: undefined;
-            /**
-           * 好莱坞/腾讯视频会员
-           */
-            hollywood_vip: undefined;
-            /**
-           * QQ会员
-           */
-            qq_vip: undefined;
-            /**
-           * QQ超级会员
-           */
-            super_vip: undefined;
-            /**
-           * 是否已经赞过
-           */
-            voted: undefined;
-        };
-    }[]>;
-    /**
-     * 获取好友列表
-     */
-    GetFriendList(): Promise<{
-        /**
-         * - 用户UID
-         */
-        uid: string;
-        /**
-       * - 用户UIN
-       */
-        uin: string;
-        /**
-       * - qid
-       */
-        qid: string;
-        /**
-       * - 名称
-       */
-        nick: string;
-        /**
-       * - 备注
-       */
-        remark: string;
-        /**
-       * - 用户等级
-       */
-        level: number;
-        /**
-       * - 生日
-       */
-        birthday: string;
-        /**
-       * - 登录天数
-       */
-        login_day: number;
-        /**
-       * - 点赞数
-       */
-        vote_cnt: number;
-        /**
-       * - 学校是否已核实
-       */
-        is_school_verified: undefined;
-        /**
-       * - 年龄
-       * - 拓展字段
-       */
-        age: number;
-        /**
-       * - 性别
-       * - 拓展字段
-       */
-        sex: "unknown" | "male" | "female";
-        ext: {
-            /**
-             * 大会员
-             */
-            big_vip: undefined;
-            /**
-           * 好莱坞/腾讯视频会员
-           */
-            hollywood_vip: undefined;
-            /**
-           * QQ会员
-           */
-            qq_vip: undefined;
-            /**
-           * QQ超级会员
-           */
-            super_vip: undefined;
-            /**
-           * 是否已经赞过
-           */
-            voted: undefined;
-        };
-    }[]>;
-    /**
-     * 获取群信息
-     * @param group_id - 群号
-     * @param no_cache - 是否不使用缓存
-     */
-    GetGroupInfo(group_id: string, no_cache?: boolean): Promise<GroupInfo>;
-    /**
-     * 获取群列表
-     */
-    GetGroupList(): Promise<{
-        group_id: string;
-        group_name: string;
-        group_remark: string;
-        max_member_count: number;
-        member_count: number;
-        group_uin: string;
-        admins: never[];
-        owner: string;
-    }[]>;
-    /**
-     * 获取群成员信息
-     * @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: string;
-        uin: string;
-        nick: string;
-        role: Role;
-        age: number;
-        unique_title: string;
-        unique_title_expire_time: number;
-        card: string;
-        join_time: number;
-        last_active_time: number;
-        level: number;
-        shut_up_time: number;
-        distance: undefined;
-        honors: never[];
-        unfriendly: boolean;
-        card_changeable: boolean;
-    }>;
-    /**
-     * 获取群成员列表
-     * @param group_id - 群号
-     * @param refresh - 是否刷新缓存，默认为 false
-     */
-    GetGroupMemberList(group_id: string, refresh?: boolean): Promise<{
-        uid: string;
-        uin: string;
-        nick: string;
-        role: Role;
-        age: number;
-        unique_title: string;
-        unique_title_expire_time: number;
-        card: string;
-        join_time: number;
-        last_active_time: number;
-        level: number;
-        shut_up_time: number;
-        distance: undefined;
-        honors: never[];
-        unfriendly: boolean;
-        card_changeable: boolean;
-    }[]>;
-    /**
-     * 获取群荣誉信息
-     */
-    GetGroupHonor(group_id: string, refresh?: boolean): Promise<GroupHonorInfo[]>;
-    /**
-     * 对消息进行表情回应
-     * @param contact - 联系人信息
-     * @param message_id - 消息ID
-     * @param face_id - 表情ID
-     */
-    ReactMessageWithEmoji(contact: Contact, message_id: string, face_id: number, is_set?: boolean): Promise<boolean>;
-    /**
-     * 获取版本信息
-     */
-    GetVersion(): Promise<{
-        name: string;
-        app_name: string;
-        version: string;
-        protocol: string;
-    }>;
-    DownloadForwardMessage(res_id: string): Promise<any>;
-    /**
-     * 精华消息
-     */
-    GetEssenceMessageList(group_id: string, page: number, page_size: number): Promise<EssenceMessageBody[]>;
-    /**
-     * 上传群文件
-     * @param group_id - 群号
-     * @param file - 本地文件绝对路径
-     * @param name - 文件名称 必须提供
-     * @param folder - 父目录ID 不提供则上传到根目录
-     */
-    UploadGroupFile(group_id: string, file: string, name: string, folder?: string): Promise<boolean>;
-    /**
-     * 上传私聊文件
-     * @param user_id - 用户ID
-     * @param file - 本地文件绝对路径
-     * @param name - 文件名称 必须提供
-     */
-    UploadPrivateFile(user_id: string, file: string, name: string): Promise<boolean>;
-    /**
-     * 设置精华消息
-     * @param _group_id - 群号
-     * @param message_id - 消息ID
-     */
-    SetEssenceMessage(_group_id: string, message_id: string): Promise<boolean>;
-    /**
-     * 移除精华消息
-     * @param _group_id - 群号
-     * @param message_id - 消息ID
-     */
-    DeleteEssenceMessage(_group_id: string, message_id: string): Promise<boolean>;
-    PokeMember(group_id: string, target_uid_or_uin: string): Promise<void>;
-    SetFriendApplyResult(request_id: string, is_approve: boolean, remark?: string): Promise<boolean>;
-    SetGroupApplyResult(request_id: string, is_approve: boolean, deny_reason?: string): Promise<boolean>;
-    SetInvitedJoinGroupResult(request_id: string, is_approve: boolean, deny_reason?: string): Promise<boolean>;
-    DownloadFile(): Promise<any>;
-    CreateFolder(): Promise<any>;
-    RenameFolder(): Promise<any>;
-    DeleteFolder(): Promise<any>;
-    DeleteFile(): Promise<any>;
-    GetFileList(): Promise<any>;
-    UploadFile(): Promise<any>;
-    GetFileSystemInfo(): Promise<any>;
-    ModifyGroupRemark(): Promise<any>;
-    GetRemainCountAtAll(): Promise<any>;
-    GetProhibitedUserList(): Promise<any>;
-    SetMessageReaded(): Promise<any>;
-    sendForwardMessage(contact: Contact, elements: NodeElement[]): Promise<{
-        message_id: string;
-    }>;
-    /**
-     * 发送API请求
-     * @param action - API断点
-     * @param {object} params - API参数
-     * @returns {Promise<any>} - API返回
-     */
-    SendApi<T extends keyof OB11ApiParams>(action: T, params?: OB11ApiParams[T], time?: number): Promise<OB11ApiResponse[T]>;
-}
-declare const _default: {
-    type: string;
-    path: string;
-    adapter: typeof AdapterOneBot11;
-};
-export default _default;