node-karin 0.8.10 → 0.8.13

package/lib/adapter/kritor/index.d.ts

@@ -1,411 +0,0 @@
-import grpc from '@grpc/grpc-js';
-import { kritor } from 'kritor-proto';
-import { Contact, KarinAdapter, KarinElement, Sender } from '../../types/index.js';
-/**
- * @extends KarinAdapter
- */
-export default class AdapterKritor implements KarinAdapter {
-    #private;
-    account: KarinAdapter['account'];
-    adapter: KarinAdapter['adapter'];
-    version: KarinAdapter['version'];
-    /**
-     * - gRPC 服务
-     */
-    grpc: grpc.ServerDuplexStream<kritor.event.EventStructure, kritor.event.RequestPushEvent>;
-    /**
-     * - 自增索引
-     */
-    seq: number;
-    constructor(
-    /**
-     * - gRPC 服务
-     */
-    grpc: grpc.ServerDuplexStream<kritor.event.EventStructure, kritor.event.RequestPushEvent>, uid: string, uin: string);
-    get self_id(): string;
-    /**
-     * 编码
-     * @param service - 服务名
-     * @param cmd - 方法名
-     * @param type - 类型
-     * @param buf - 数据
-     */
-    encode(service: string, cmd: string, type: string, buf: Uint8Array): {
-        cmd: string;
-        buf: Uint8Array;
-    };
-    /**
-     * 解码
-     * @param cmd - 服务名.方法名
-     * @param type - 类型
-     * @param buf - 数据
-     */
-    decode(cmd: string, type: string, buf: Uint8Array): any;
-    /**
-     * karin 转 kritor
-     * @param data - 消息元素
-     */
-    AdapterConvertKarin(data: kritor.common.Element[]): KarinElement[];
-    /**
-     * karin 转 kritor
-     */
-    KarinConvertAdapter(elements: KarinElement[]): Array<kritor.common.Element>;
-    /**
-     * 发送消息
-     * @param contact - 联系人
-     * @param elements - 消息元素
-     * @param retry_count - 重试次数
-     */
-    SendMessage(contact: Contact, elements: KarinElement[], retry_count?: number): Promise<{
-        message_id: string;
-        message_time: number;
-    }>;
-    /**
-     * 撤回消息
-     * @param contact - 联系人
-     * @param message_id - 消息ID
-     */
-    RecallMessage(contact: Contact, message_id: string): Promise<any>;
-    /**
-     * 设置消息评论表情
-     * @param contact - 联系人
-     * @param message_id - 消息ID
-     * @param face_id - 表情ID
-     * @param is_set - 是否设置
-     */
-    ReactMessageWithEmoji(contact: Contact, message_id: string, face_id: number, is_set: boolean): Promise<any>;
-    /**
-     * 获取msg_id获取消息
-     * @param contact - 联系人
-     * @param message_id - 消息ID
-     */
-    GetMessage(contact: Contact, message_id: string): Promise<{
-        time: number;
-        message_id: string;
-        message_seq: number;
-        contact: Contact;
-        sender: Sender;
-        elements: KarinElement[];
-    }>;
-    /**
-     * 通过seq获取消息
-     * @param contact - 联系人
-     * @param message_seq - 消息seq
-     */
-    GetMessageBySeq(contact: Contact, message_seq: number): Promise<kritor.message.GetMessageBySeqResponse>;
-    /**
-     * 获取msg_id获取历史消息
-     * @param contact - 联系人
-     * @param start_message_id - 开始消息ID
-     * @param count - 数量
-     */
-    GetHistoryMessage(contact: Contact, start_message_id: string, count: number): Promise<any>;
-    /**
-     * 通过seq获取历史消息
-     * @param contact - 联系人
-     * @param start_message_seq - 开始消息seq
-     * @param count - 数量
-     */
-    GetHistoryMessageBySeq(contact: Contact, start_message_seq: number, count: number): Promise<kritor.message.GetHistoryMessageBySeqResponse>;
-    /**
-     * 清空本地聊天记录
-     * @param contact - 联系人
-     */
-    SetMessageReaded(contact: Contact): Promise<boolean>;
-    /**
-     * 上传合并转发消息
-     * @param contact - 联系人
-     * @param elements - 消息
-     * @param retry_count - 重试次数
-     */
-    UploadForwardMessage(contact: Contact, elements: any[], retry_count?: number): Promise<any>;
-    /**
-     * 下载合并转发消息
-     * @param res_id - 资源ID
-     */
-    DownloadForwardMessage(res_id: string): Promise<any>;
-    /**
-     * 获取精华消息
-     * @param group_id - 群组ID
-     * @param page - 页码
-     * @param page_size - 每页数量
-     */
-    GetEssenceMessageList(group_id: string, page: number, page_size: number): Promise<any>;
-    /** 设置精华消息 */
-    SetEssenceMessage(group_id: string, message_id: string): Promise<any>;
-    /**
-     * 删除精华消息
-     * @param group_id - 群组ID
-     * @param message_id - 消息ID
-     */
-    DeleteEssenceMessage(group_id: string, message_id: string): Promise<any>;
-    logger(level: 'trace' | 'debug' | 'mark' | 'info' | 'mark' | 'warn' | 'error' | 'fatal', ...args: any[]): void;
-    /**
-    * 获取用户头像
-    * @param {string} uid - 用户id，默认为发送者uid
-    * @param {number} [size] - 头像大小，默认`0`
-    * @returns {string} - 头像的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;
-    /**
-     * 获取Kritor版本
-     */
-    GetVersion(): Promise<kritor.core.GetVersionResponse>;
-    /**
-     * 让Kritor下载文件到Kritor本地
-     * @param file - 文件地址
-     * @param file_type - 文件类型
-     * @param root_path - 文件保存路径
-     * @param file_name - 文件名
-     * @param thread_cnt - 线程数
-     * @param headers - 请求头
-     * @returns - 下载文件的响应
-     */
-    DownloadFile(options: {
-        file: string;
-        file_type: 'url' | 'base64';
-        root_path?: string;
-        file_name?: string;
-        thread_cnt?: number;
-        headers?: string;
-    }): Promise<kritor.core.DownloadFileResponse>;
-    /**
-     * 获取当前账户的信息
-     */
-    GetCurrentAccount(): Promise<{
-        account_uin: string;
-        account_uid: string;
-        account_name: string;
-    }>;
-    /**
-     * 获取好友列表
-     * @param refresh - 是否刷新缓存
-     */
-    GetFriendList(refresh: boolean): Promise<any>;
-    /**
-     * 获取好友名片信息
-     * @param options - 好友名片信息选项
-     */
-    GetFriendProfileCard(options: {
-        target_uids?: string[];
-        target_uins?: number[];
-    }): Promise<any>;
-    /**
-     * 获取陌生人信息
-     * @param target_uid_or_uin - 目标用户的 uid 或者 uin 数组
-     */
-    GetStrangerProfileCard(target_uid_or_uin: string[]): Promise<any>;
-    /**
-     * 设置自己的名片
-     * @param options - 名片信息选项
-     */
-    SetProfileCard(options: {
-        /**
-         * 昵称
-         */
-        nick_name?: string;
-        /**
-         * 公司
-         */
-        company?: string;
-        /**
-         * 邮箱
-         */
-        email?: string;
-        /**
-         * 学校
-         */
-        college?: string;
-        /**
-         * 个人备注
-         */
-        personal_note?: string;
-        /**
-         * 生日
-         */
-        birthday?: number;
-        /**
-         * 年龄
-         */
-        age?: number;
-    }): Promise<any>;
-    /**
-     * 判断是否是黑名单用户
-     * @param target_uid - 目标用户的 uid
-     * @param target_uin - 目标用户的 uin
-     */
-    IsBlackListUser(target_uid: string, target_uin: string): Promise<any>;
-    /**
-     * 点赞好友
-     * @param target_uid_or_uin - 目标用户的 uid 或者 uin
-     * @param vote_count - 点赞数量
-     */
-    VoteUser(target_uid_or_uin: string, vote_count: number): Promise<any>;
-    /**
-     * 根据 uin 获取 uid
-     * @param target_uins - 目标用户的 uin 数组
-     */
-    GetUidByUin(target_uins: number[]): Promise<any>;
-    /**
-     * 根据 uid 获取 uin
-     * @param target_uids - 目标用户的 uid 数组
-     */
-    GetUinByUid(target_uids: string[]): Promise<any>;
-    /**
-     * 禁言用户
-     * @param group_id - 群组ID
-     * @param target_uid_or_uin - 被禁言目标的 uid 任选其一
-     * @param duration - 禁言时长 单位秒
-     */
-    BanMember(group_id: string, target_uid_or_uin: string, duration: number): Promise<any>;
-    /**
-     * 戳一戳用户头像
-     * @param options - 戳一戳选项
-     */
-    PokeMember(group_id: string, target_uid_or_uin: string): Promise<any>;
-    /**
-     * 群组踢人
-     * @param group_id - 群组ID
-     * @param target_uid_or_uin - 被踢目标的 uid、uin 任选其一
-     * @param reject_add_request - 是否拒绝再次入群请求
-     * @param kick_reason - 踢人原因
-     */
-    KickMember(group_id: string, target_uid_or_uin: string, reject_add_request?: boolean, kick_reason?: string): Promise<any>;
-    /**
-     * 退出群组
-     * @param group_id - 群组ID
-     */
-    LeaveGroup(group_id: string): Promise<any>;
-    /**
-     * 修改群名片
-     * @param group_id - 群组ID
-     * @param target_uid_or_uin - 目标用户的 uid、uin 任选其一
-     * @param card - 新的群名片
-     */
-    ModifyMemberCard(group_id: string, target_uid_or_uin: string, card: string): Promise<any>;
-    /**
-     * 修改群名称
-     * @param group_id - 群组ID
-     * @param group_name - 新的群名称
-     */
-    ModifyGroupName(group_id: string, group_name: string): Promise<any>;
-    /**
-     * 修改群备注
-     * @param group_id - 群组ID
-     * @param remark - 新的群备注
-     */
-    ModifyGroupRemark(group_id: string, remark: string): Promise<any>;
-    /**
-     * 设置群管理员
-     * @param group_id - 群组ID
-     * @param target_uid_or_uin - 目标用户的 uid、uin 任选其一
-     * @param is_admin - 是否设置为管理员
-     */
-    SetGroupAdmin(group_id: string, target_uid_or_uin: string, is_admin: boolean): Promise<any>;
-    /**
-     * 设置群头衔
-     * @param group_id - 群组ID
-     * @param target_uid_or_uin - 目标用户的 uid、uin 任选其一
-     * @param special_title - 新的群头衔
-     */
-    SetGroupUniqueTitle(group_id: string, target_uid_or_uin: string, unique_title: string): Promise<any>;
-    /**
-     * 设置全员禁言
-     * @param group_id - 群组ID
-     * @param is_ban - 是否全员禁言
-     */
-    SetGroupWholeBan(group_id: string, is_ban: boolean): Promise<any>;
-    /**
-     * 获取群信息
-     * @param group_id - 群组ID
-     * @param no_cache - 是否刷新缓存
-     */
-    GetGroupInfo(group_id: string, no_cache?: boolean): Promise<any>;
-    /**
-     * 获取群列表
-     * @param refresh - 是否刷新缓存
-     */
-    GetGroupList(refresh?: boolean): Promise<any>;
-    /**
-     * 获取群成员信息
-     * @param group_id - 群组ID
-     * @param target_uid_or_uin - 目标用户的 uid、uin 任选其一
-     * @param refresh - 是否刷新缓存
-     */
-    GetGroupMemberInfo(group_id: string, target_uid_or_uin: string, refresh?: boolean): Promise<any>;
-    /**
-     * 获取群成员列表
-     * @param group_id - 群组ID
-     * @param refresh - 是否刷新缓存
-     */
-    GetGroupMemberList(group_id: string, refresh?: boolean): Promise<any>;
-    /**
-     * 获取禁言用户列表
-     * @param group_id - 群组ID
-     */
-    GetProhibitedUserList(group_id: string): Promise<any>;
-    /**
-     * 获取艾特全体成员剩余次数
-     * @param group_id - 群组ID
-     */
-    GetRemainCountAtAll(group_id: string): Promise<any>;
-    /**
-   * 获取群荣誉信息
-   * @param group_id - 群组ID
-   * @param refresh - 是否刷新缓存
-   * @returns - 群荣誉信息
-   */
-    GetGroupHonor(group_id: string, refresh?: boolean): Promise<any>;
-    /**
-     * 获取未加入群组信息
-     * @param group_id - 群组ID
-     */
-    GetNotJoinedGroupInfo(group_id: string): Promise<any>;
-    /**
-     * 设置好友请求结果
-     * @param request_id - 请求ID
-     * @param is_approve - 是否同意
-     * @param remark - 好友备注 同意时有效
-     * @returns
-     */
-    SetFriendApplyResult(request_id: string, is_approve: boolean, remark: string): Promise<any>;
-    /**
-     * 设置申请加入群请求结果
-     * @param request_id - 请求ID
-     * @param is_approve - 是否同意
-     * @param deny_reason - 拒绝原因
-     */
-    SetGroupApplyResult(request_id: string, is_approve: boolean, deny_reason: string): Promise<any>;
-    /**
-     * 设置邀请加入群请求结果
-     * @param request_id - 请求ID
-     * @param is_approve - 是否同意
-     */
-    SetInvitedJoinGroupResult(request_id: string, is_approve: boolean): Promise<any>;
-    CreateFolder(): Promise<any>;
-    RenameFolder(): Promise<any>;
-    DeleteFolder(): Promise<any>;
-    UploadFile(): Promise<any>;
-    DeleteFile(): Promise<any>;
-    GetFileSystemInfo(): Promise<any>;
-    GetFileList(): Promise<any>;
-    SendMessageByResId(contact: Contact, id: string): Promise<any>;
-    sendForwardMessage(contact: Contact, elements: Array<any>): Promise<any>;
-    UploadGroupFile(group_id: string, file: string, name: string, folder?: string): Promise<any>;
-    UploadPrivateFile(user_id: string, file: string, name: string): Promise<any>;
-    /**
-     * 发送Api请求 返回未解码的数据
-     * @param cmd - cmd的构成由 服务名 + "." + 方法名
-     * @param buf - 请求参数
-     * @param time - 请求超时时间 默认10s
-     */
-    SendApi(cmd: string, buf: any, time?: number): Promise<kritor.common.Response>;
-}