@mrlingxd/koishi-plugin-adapter-onebot 0.1.0 → 0.2.1

package/lib/types/event/base.d.ts

@@ -0,0 +1,26 @@
+import { EventType } from "../enum";
+/** 消息子类型 */
+export declare enum SubType {
+    /** 好友 */
+    Friend = "friend",
+    /** 群聊 */
+    Normal = "normal",
+    /** 匿名 */
+    Anonymous = "anonymous",
+    /** 群中自身发送 */
+    GroupSelf = "group_self",
+    /** 群临时会话 */
+    Group = "group",
+    /** 系统提示 */
+    Notice = "notice"
+}
+/** 基础事件 */
+export interface BaseEvent<T extends EventType> {
+    /** 事件发生的时间戳 */
+    time: number;
+    /** 收到事件的机器人 QQ 号 */
+    self_id: number;
+    /** 上报类型 */
+    post_type: T;
+}
+export declare function isBaseEvent(event: any): event is BaseEvent<EventType>;

package/lib/types/event/base.js

@@ -0,0 +1,20 @@
+/** 消息子类型 */
+export var SubType;
+(function (SubType) {
+    /** 好友 */
+    SubType["Friend"] = "friend";
+    /** 群聊 */
+    SubType["Normal"] = "normal";
+    /** 匿名 */
+    SubType["Anonymous"] = "anonymous";
+    /** 群中自身发送 */
+    SubType["GroupSelf"] = "group_self";
+    /** 群临时会话 */
+    SubType["Group"] = "group";
+    /** 系统提示 */
+    SubType["Notice"] = "notice";
+})(SubType || (SubType = {}));
+// 类型守卫
+export function isBaseEvent(event) {
+    return event && typeof event === "object" && "post_type" in event && "time" in event && "self_id" in event;
+}

package/lib/types/event/message.d.ts

@@ -0,0 +1,44 @@
+import { CQCode } from "../../bot/cqcode";
+import { EventType } from "../enum";
+import { Anonymous, GroupSender, Sender } from "../sender";
+import { BaseEvent, SubType } from "./base";
+/** 消息事件接口 */
+interface BaseMessageEvent<S extends Sender | GroupSender, M extends "private" | "group"> extends BaseEvent<EventType.MESSAGE | EventType.MESSAGE_SENT> {
+    /** 消息类型 */
+    message_type: M;
+    /** 消息子类型 */
+    sub_type: SubType;
+    /** 消息 ID */
+    message_id: number;
+    /** 发送者 QQ 号 */
+    user_id: number;
+    /** 消息内容 */
+    message: string | CQCode[];
+    /** 原始消息内容 */
+    raw_message: string;
+    /** 字体 */
+    font: number;
+    /** 发送人信息 */
+    sender: S;
+    /** 更多字段 */
+    [property: string]: unknown;
+}
+export declare function isMessageEvent(event: BaseEvent<EventType>): event is MessageEvent;
+export declare function isPrivateMessageEvent(event: BaseEvent<EventType>): event is PrivateMessageEvent;
+export declare function isGroupMessageEvent(event: BaseEvent<EventType>): event is GroupMessageEvent;
+/** 私聊消息事件 */
+export interface PrivateMessageEvent extends BaseMessageEvent<Sender, "private"> {
+    /** 更多字段 */
+    [property: string]: unknown;
+}
+/** 群消息事件 */
+export interface GroupMessageEvent extends BaseMessageEvent<GroupSender, "group"> {
+    /** 群号 */
+    group_id: number;
+    /** 匿名信息 */
+    anonymous?: Anonymous;
+    /** 更多字段 */
+    [property: string]: unknown;
+}
+export type MessageEvent = PrivateMessageEvent | GroupMessageEvent;
+export {};

package/lib/types/event/message.js

@@ -0,0 +1,11 @@
+import { EventType } from "../enum";
+// 类型守卫
+export function isMessageEvent(event) {
+    return event.post_type === EventType.MESSAGE || event.post_type === EventType.MESSAGE_SENT;
+}
+export function isPrivateMessageEvent(event) {
+    return isMessageEvent(event) && event.message_type === "private";
+}
+export function isGroupMessageEvent(event) {
+    return isMessageEvent(event) && event.message_type === "group";
+}

package/lib/types/event/meta.d.ts

@@ -0,0 +1,34 @@
+import { EventType } from "../enum";
+import { BaseEvent } from "./base";
+/** 元事件 */
+interface MetaEvent<meta_event_type extends "lifecycle" | "heartbeat"> extends BaseEvent<EventType.META> {
+    /** 元事件类型 */
+    meta_event_type: meta_event_type;
+}
+/** 心跳包 */
+export interface HeartbeatMetaEvent extends MetaEvent<"heartbeat"> {
+    /** 心跳状态 */
+    status: {
+        /**
+         *  当前 QQ 在线
+         *
+         *  undefined 表示无法查询到在线状态
+         */
+        online?: boolean;
+        /** 状态符合预期，意味着各模块正常运行、功能正常，且 QQ 在线 */
+        good: boolean;
+    };
+    /** 距离上一次心跳包的时间（单位是毫秒） */
+    interval: number;
+}
+/** 生命周期 */
+export interface LifecycleMetaEvent extends MetaEvent<"lifecycle"> {
+    /** 子类型
+     *
+     * - enable: 启用
+     * - disable: 禁用
+     * - connect: 连接成功
+     */
+    sub_type: "enable" | "disable" | "connect";
+}
+export {};

package/lib/types/event/meta.js

@@ -0,0 +1 @@
+export {};

package/lib/types/event/notice.d.ts

@@ -0,0 +1,256 @@
+import { Device } from "../device";
+import { EventType } from "../enum";
+import { BaseEvent } from "./base";
+/**
+ * 通知事件类型
+ */
+export declare enum NoticeType {
+    /** 群文件上传事件 */
+    GROUP_UPLOAD = "group_upload",
+    /** 群管理员变动事件*/
+    GROUP_ADMIN = "group_admin",
+    /** 群成员减少事件 */
+    GROUP_DECREASE = "group_decrease",
+    /** 群成员增加事件 */
+    GROUP_INCREASE = "group_increase",
+    /** 群禁言事件 */
+    GROUP_BAN = "group_ban",
+    /** 群消息撤回事件 */
+    GROUP_RECALL = "group_recall",
+    /** 好友添加事件 */
+    FRIEND_ADD = "friend_add",
+    /** 好友消息撤回事件 */
+    FRIEND_RECALL = "friend_recall",
+    /** 特殊通知事件 */
+    NOTIFY = "notify",
+    /** 群名片变更（go-cqhttp 扩展事件） */
+    GROUP_CARD = "group_card",
+    /** 接收到离线文件（go-cqhttp 扩展事件） */
+    OFFLINE_FILE = "offline_file",
+    /** 其他客户端在线状态变更（go-cqhttp 扩展事件） */
+    CLIENT_STATUS = "client_status",
+    /** 精华消息变更（go-cqhttp 扩展事件）*/
+    GROUP_ESSENCE = "essence"
+}
+/** 通知事件 */
+interface NoticeEvent<notice_type extends NoticeType> extends BaseEvent<EventType.NOTICE> {
+    /** 通知类型 */
+    notice_type: notice_type;
+}
+export declare function isNoticeEvent(event: BaseEvent<EventType>): event is AllNoticeEvents;
+/** 群文件信息 */
+export interface GroupUploadFile {
+    /** 文件 ID */
+    id: string;
+    /** 文件名 */
+    name: string;
+    /** 文件大小，单位字节 */
+    size: number;
+    /** 业务ID */
+    busid: number;
+}
+/** 群文件上传 */
+export interface GroupUploadNotice extends NoticeEvent<NoticeType.GROUP_UPLOAD> {
+    /** 群号 */
+    group_id: number;
+    /** 发送者 QQ 号 */
+    user_id: number;
+}
+/** 群管理员变动 */
+export interface GroupAdminNotice extends NoticeEvent<NoticeType.GROUP_ADMIN> {
+    /**
+     * 事件子类型
+     *
+     * - set: 设置管理员
+     * - unset: 取消管理员
+     */
+    sub_type: "set" | "unset";
+    /** 群号 */
+    group_id: number;
+    /** 管理员 QQ 号 */
+    user_id: number;
+}
+/** 群成员减少 */
+export interface GroupDecreaseNotice extends NoticeEvent<NoticeType.GROUP_DECREASE> {
+    /**
+     * 事件子类型
+     *
+     * - leave: 主动退群
+     * - kick: 成员被踢
+     * - kick_me: 登录号被踢
+     */
+    sub_type: "leave" | "kick" | "kick_me";
+    /** 群号 */
+    group_id: number;
+    /**
+     * 操作者 QQ 号
+     *
+     * 对于主动退群的成员，该字段为操作者本人 QQ 号
+     */
+    operator_id: number;
+    /** 离开者 QQ 号 */
+    user_id: number;
+}
+/** 群成员增加 */
+export interface GroupIncreaseNotice extends NoticeEvent<NoticeType.GROUP_INCREASE> {
+    /**
+     * 事件子类型
+     *
+     * - approve: 管理员同意入群
+     * - invite: 成员邀请入群
+     */
+    sub_type: "approve" | "invite";
+    /** 群号 */
+    group_id: number;
+    /** 操作者 QQ 号 */
+    operator_id: number;
+    /** 加入者 QQ 号 */
+    user_id: number;
+}
+/** 群禁言 */
+export interface GroupBanNotice extends NoticeEvent<NoticeType.GROUP_BAN> {
+    /**
+     * 事件子类型
+     *
+     * - ban: 禁言
+     * - lift_ban: 解除禁言
+     *  */
+    sub_type: "ban" | "lift_ban";
+    /** 群号 */
+    group_id: number;
+    /** 操作者 QQ 号 */
+    operator_id: number;
+    /** 被禁言 QQ 号，0 代表全员禁言 */
+    user_id: number;
+    /** 禁言时长，单位秒（全员禁言为时为-1） */
+    duration: number;
+}
+/** 群消息撤回 */
+export interface GroupRecallNotice extends NoticeEvent<NoticeType.GROUP_RECALL> {
+    /** 群号 */
+    group_id: number;
+    /** 消息发送者 QQ 号 */
+    user_id: number;
+    /** 操作者 QQ 号 */
+    operator_id: number;
+    /** 被撤回的消息 ID */
+    message_id: number;
+}
+/** 戳一戳 */
+export interface NotifyPokeNotice extends NoticeEvent<NoticeType.NOTIFY> {
+    /** 提示类型 */
+    sub_type: "poke";
+    /** 发送者 QQ 号 */
+    user_id: number;
+    /** 被戳者 QQ 号 */
+    target_id: number;
+}
+export declare function isGroupPokeNotice(event: NoticeEvent<NoticeType.NOTIFY>): event is NotifyGroupPokeNotice;
+/** 群内戳一戳 */
+export interface NotifyGroupPokeNotice extends NotifyPokeNotice {
+    /** 群号 */
+    group_id: number;
+}
+/** 群红包运气王 */
+export interface NotifyLuckyKingNotice extends NoticeEvent<NoticeType.NOTIFY> {
+    /** 提示类型 */
+    sub_type: "lucky_king";
+    /** 群号 */
+    group_id: number;
+    /** 红包发送者 QQ 号 */
+    user_id: number;
+    /** 运气王 QQ 号 */
+    target_id: number;
+}
+/** 群成员荣誉变更 */
+export interface NotifyHonorNotice extends NoticeEvent<NoticeType.NOTIFY> {
+    /** 提示类型 */
+    sub_type: "honor";
+    /** 群号 */
+    group_id: number;
+    /**
+     * 荣誉类型
+     *
+     * - talkative: 龙王
+     * - performer: 群聊之火
+     * - emotion: 快乐源泉
+     */
+    honor_type: "talkative" | "performer" | "emotion";
+    /** 成员 QQ 号 */
+    user_id: number;
+}
+/** 群成员头衔变更（go-cqhttp 扩展事件） */
+export interface NotifyTitleNotice extends NoticeEvent<NoticeType.NOTIFY> {
+    /** 提示类型 */
+    sub_type: "title";
+    /** 群号 */
+    group_id: number;
+    /** 变更头衔的用户 QQ 号 */
+    user_id: number;
+    /** 变更后的头衔 */
+    title: string;
+}
+/** 好友添加 */
+export interface FriendAddNotice extends NoticeEvent<NoticeType.FRIEND_ADD> {
+    /** 新添加好友 QQ 号 */
+    user_id: number;
+}
+/** 好友消息撤回 */
+export interface FriendRecallNotice extends NoticeEvent<NoticeType.FRIEND_RECALL> {
+    /** 好友 QQ 号 */
+    user_id: number;
+    /** 被撤回的消息 ID */
+    message_id: number;
+}
+/** 群名片变更（go-cqhttp 扩展事件） */
+export interface GroupCardNotice extends NoticeEvent<NoticeType.GROUP_CARD> {
+    /** 群号 */
+    group_id: number;
+    /** 成员 QQ 号 */
+    user_id: number;
+    /** 变更后的群名片 */
+    card_new: string;
+    /** 变更前的群名片 */
+    card_old: string;
+}
+/** 接收到离线文件（go-cqhttp 扩展事件） */
+export interface OfflineFileNotice extends NoticeEvent<NoticeType.OFFLINE_FILE> {
+    /** 发送者 QQ 号 */
+    user_id: number;
+    /** 文件数据 */
+    file: {
+        /** 文件名 */
+        name: string;
+        /** 文件大小，单位字节 */
+        size: number;
+        /** 文件下载 URL */
+        url: string;
+    };
+}
+/** 其他客户端在线状态变更（go-cqhttp 扩展事件） */
+export interface ClientStatusNotice extends NoticeEvent<NoticeType.CLIENT_STATUS> {
+    /** 客户端信息 */
+    client: Device;
+    /** 当前是否在线 */
+    online: boolean;
+}
+/** 精华消息变更（go-cqhttp 扩展事件）*/
+export interface GroupEssenceNotice extends NoticeEvent<NoticeType.GROUP_ESSENCE> {
+    /**
+     * 事件子类型
+     *
+     * - add: 添加精华消息
+     * - delete: 删除精华消息
+     */
+    sub_type: "add" | "delete";
+    /** 群号 */
+    group_id: number;
+    /** 消息发送者 ID */
+    sender_id: number;
+    /** 操作者 QQ 号 */
+    operator_id: number;
+    /** 消息 ID */
+    message_id: number;
+}
+export type AllNoticeEvents = GroupUploadNotice | GroupAdminNotice | GroupDecreaseNotice | GroupIncreaseNotice | GroupBanNotice | GroupRecallNotice | NotifyPokeNotice | NotifyGroupPokeNotice | NotifyLuckyKingNotice | NotifyHonorNotice | NotifyTitleNotice | FriendAddNotice | FriendRecallNotice | GroupCardNotice | OfflineFileNotice | ClientStatusNotice | GroupEssenceNotice;
+export {};

package/lib/types/event/notice.js

@@ -0,0 +1,40 @@
+import { EventType } from "../enum";
+/**
+ * 通知事件类型
+ */
+export var NoticeType;
+(function (NoticeType) {
+    /** 群文件上传事件 */
+    NoticeType["GROUP_UPLOAD"] = "group_upload";
+    /** 群管理员变动事件*/
+    NoticeType["GROUP_ADMIN"] = "group_admin";
+    /** 群成员减少事件 */
+    NoticeType["GROUP_DECREASE"] = "group_decrease";
+    /** 群成员增加事件 */
+    NoticeType["GROUP_INCREASE"] = "group_increase";
+    /** 群禁言事件 */
+    NoticeType["GROUP_BAN"] = "group_ban";
+    /** 群消息撤回事件 */
+    NoticeType["GROUP_RECALL"] = "group_recall";
+    /** 好友添加事件 */
+    NoticeType["FRIEND_ADD"] = "friend_add";
+    /** 好友消息撤回事件 */
+    NoticeType["FRIEND_RECALL"] = "friend_recall";
+    /** 特殊通知事件 */
+    NoticeType["NOTIFY"] = "notify";
+    /** 群名片变更（go-cqhttp 扩展事件） */
+    NoticeType["GROUP_CARD"] = "group_card";
+    /** 接收到离线文件（go-cqhttp 扩展事件） */
+    NoticeType["OFFLINE_FILE"] = "offline_file";
+    /** 其他客户端在线状态变更（go-cqhttp 扩展事件） */
+    NoticeType["CLIENT_STATUS"] = "client_status";
+    /** 精华消息变更（go-cqhttp 扩展事件）*/
+    NoticeType["GROUP_ESSENCE"] = "essence";
+})(NoticeType || (NoticeType = {}));
+// 类型守卫
+export function isNoticeEvent(event) {
+    return event.post_type === EventType.NOTICE;
+}
+export function isGroupPokeNotice(event) {
+    return event.group_id !== undefined;
+}

package/lib/types/event/request.d.ts

@@ -0,0 +1,30 @@
+import { EventType } from "../enum";
+import { BaseEvent } from "./base";
+/** 请求事件 */
+export interface RequestEvent<request_type extends "friend" | "group"> extends BaseEvent<EventType.REQUEST> {
+    /** 请求类型 */
+    request_type: request_type;
+    /** 发送者 QQ 号 */
+    user_id: number;
+    /** 验证信息 */
+    comment: string;
+    /** 请求标识符 */
+    flag: string;
+}
+export declare function isRequestEvent(event: BaseEvent<EventType>): event is RequestEvent<"friend" | "group">;
+export declare function isFriendRequest(event: BaseEvent<EventType>): event is FriendRequest;
+export declare function isGroupRequest(event: BaseEvent<EventType>): event is GroupRequest;
+/** 加好友请求 */
+export interface FriendRequest extends RequestEvent<"friend"> {
+}
+/** 加群请求/邀请 */
+export interface GroupRequest extends RequestEvent<"group"> {
+    /** 事件子类型
+     *
+     * - add: 加群请求
+     * - invite: 邀请登录号入群
+     */
+    sub_type: "add" | "invite";
+    /** 群号 */
+    group_id: number;
+}

package/lib/types/event/request.js

@@ -0,0 +1,11 @@
+import { EventType } from "../enum";
+// 类型守卫
+export function isRequestEvent(event) {
+    return event.post_type === EventType.REQUEST;
+}
+export function isFriendRequest(event) {
+    return isRequestEvent(event) && event.request_type === "friend";
+}
+export function isGroupRequest(event) {
+    return isRequestEvent(event) && event.request_type === "group";
+}

package/lib/types/group.d.ts

@@ -0,0 +1,43 @@
+import { GroupMemberRole } from "./enum";
+import { UserInfo } from "./user";
+export interface GroupInfo {
+    /** 群号 */
+    group_id: number;
+    /** 群名称 */
+    group_name: string;
+    /** 成员数量 */
+    member_count: number;
+    /** 最大成员数量 */
+    max_member_count: number;
+    /** 更多字段 */
+    [property: string]: unknown;
+}
+/**
+ * 群成员信息
+ */
+export interface GroupMemberInfo extends UserInfo {
+    /** 群号 */
+    group_id: number;
+    /** 群名片／备注 */
+    card?: string;
+    /** 地区 */
+    area?: string;
+    /** 加群时间戳 */
+    join_time: number;
+    /** 最后发言时间戳 */
+    last_sent_time: number;
+    /** 成员等级 */
+    level: number;
+    /** 角色 */
+    role: GroupMemberRole;
+    /** 是否不良记录成员 */
+    unfriendly?: boolean;
+    /** 专属头衔 */
+    title?: string;
+    /** 专属头衔过期时间戳（0 表示永不过期） */
+    title_expire_time?: number;
+    /** 是否允许修改群名片 */
+    card_changeable?: boolean;
+    /** 更多字段 */
+    [property: string]: unknown;
+}

package/lib/types/group.js

@@ -0,0 +1 @@
+export {};