node-karin 0.3.8 → 0.4.1

package/lib/types/event.d.ts

@@ -1,5 +1,6 @@
+import { KarinAdapter } from './adapter.js';
 import { KarinElement } from './element.js';
-import { KarinMessage, KarinNotice, KarinRequest } from '../event/index.js';
+import { Reply, replyCallback } from './reply.js';
 /**
  * - 事件类型
  */
@@ -8,10 +9,6 @@ export type Event = 'message' | 'notice' | 'request' | 'meta_event' | 'message_s
  * - 事件来源
  */
 export type Scene = 'group' | 'private' | 'guild' | 'nearby' | 'stranger' | 'stranger_from_group';
-/**
- * - 事件子类型
- */
-export type SubEvent = 'group_message' | 'friend_message' | 'guild_message' | 'nearby' | 'stranger' | 'stranger_from_group' | 'friend_poke' | 'friend_recall' | 'friend_file_uploaded' | 'group_poke' | 'group_card_changed' | 'group_member_unique_title_changed' | 'group_essence_changed' | 'group_recall' | 'group_member_increase' | 'group_member_decrease' | 'group_admin_changed' | 'group_member_ban' | 'group_sign' | 'group_whole_ban' | 'group_file_uploaded' | 'friend_apply' | 'group_apply' | 'invited_group';
 /**
  * - 类型映射
  */
@@ -19,12 +16,13 @@ export type EventToSubEvent = {
     message: 'group_message' | 'friend_message' | 'guild_message' | 'nearby' | 'stranger' | 'stranger_from_group';
     notice: 'friend_poke' | 'friend_recall' | 'friend_file_uploaded' | 'group_poke' | 'group_card_changed' | 'group_member_unique_title_changed' | 'group_essence_changed' | 'group_recall' | 'group_member_increase' | 'group_member_decrease' | 'group_admin_changed' | 'group_member_ban' | 'group_sign' | 'group_whole_ban' | 'group_file_uploaded' | 'group_message_reaction';
     request: 'friend_apply' | 'group_apply' | 'invited_group';
-    meta_event: 'group_message' | 'friend_message' | 'guild_message';
+    meta_event: 'group_message' | 'friend_message' | 'guild_message' | 'nearby' | 'stranger' | 'stranger_from_group';
+    message_sent: 'group_message' | 'friend_message' | 'guild_message' | 'nearby' | 'stranger' | 'stranger_from_group';
 };
 /**
- * - 事件子类型泛型
+ * - 事件子类型
  */
-export type SubEventForEvent<E extends Event> = E extends keyof EventToSubEvent ? EventToSubEvent[E] : never;
+export type SubEvent = EventToSubEvent['message'] | EventToSubEvent['notice'] | EventToSubEvent['request'];
 /**
  * - 权限类型
  */
@@ -74,7 +72,7 @@ export interface Sender {
 /**
  * - 通知事件类型
  */
-export interface NoticeTytpe {
+export interface NoticeType {
     /**
      * - 私聊戳一戳
      */
@@ -520,10 +518,6 @@ export interface NoticeTytpe {
         is_set: boolean;
     };
 }
-/**
- * - 通知事件泛型
- */
-export type NoticeEvent<E extends keyof NoticeTytpe> = E extends keyof NoticeTytpe ? NoticeTytpe[E] : never;
 /**
  * - 请求事件类型
  */
@@ -593,315 +587,207 @@ export interface RequestType {
     };
 }
 /**
- * - 请求事件泛型
- */
-export type RequestEvent<E extends keyof RequestType> = E extends keyof RequestType ? RequestType[E] : never;
-/**
- * - 转发、历史消息返回的结构
+ * - 事件基类
  */
-export interface PushMessageBody {
-    /**
-     * - 消息发送时间
-     */
-    time: number;
-    /**
-     * - 消息ID
-     */
-    message_id: string;
-    /**
-     * - 消息序列号
-     */
-    message_seq: number;
+export interface KarinEventType {
     /**
-     * - 消息来源
-     */
-    contact: contact;
+      * - 机器人ID 请尽量使用UID
+      */
+    self_id: string;
     /**
-     * - 消息发送者
+     * - 用户ID
      */
-    sender: Sender;
+    user_id: string;
     /**
-     * - 消息元素
-     */
-    elements: Array<KarinElement>;
-}
-/**
- * - 精华消息返回的结构
- */
-export interface EssenceMessageBody {
-    /**
-     * - 群ID
+     * - 群ID 仅在群聊中存在
+     * @default ''
      */
     group_id: string;
     /**
-     * - 发送者uid
+     * - 事件类型
      */
-    sender_uid: string;
+    event: Event;
     /**
-     * - 发送者uin
+     * - 事件子类型
      */
-    sender_uin: string;
+    sub_event: EventToSubEvent[Event];
     /**
-     * - 发送者昵称
+     * - 事件ID
      */
-    sender_nick: string;
+    event_id: string;
     /**
-     * - 操作者uid
+     * - 事件触发时间戳
      */
-    operator_uid: string;
-    /**
-     * - 操作者uin
-     */
-    operator_uin: string;
-    /**
-     * - 操作者昵称
-     */
-    operator_nick: string;
-    /**
-     * - 操作时间
-     */
-    operation_time: number;
-    /**
-     * - 消息时间
-     */
-    message_time: number;
-    /**
-     * - 消息ID
-     */
-    message_id: string;
-    /**
-     * - 消息序列号
-     */
-    message_seq: string;
-    /**
-     * - 被设置的精华消息元素文本
-     */
-    json_elements: string;
-}
-/**
- * - QQ好友信息
- */
-export interface FriendInfo {
-    /**
-     * - 用户UID
-     */
-    uid: string;
-    /**
-     * - 用户UIN
-     */
-    uin: string;
-    /**
-     * - qid
-     */
-    qid: string;
-    /**
-     * - 名称
-     */
-    nick: string;
-    /**
-     * - 备注
-     */
-    remark?: string;
+    time: number;
     /**
-     * - 用户等级
+     * - 事件联系人信息
      */
-    level?: number;
+    contact: contact;
     /**
-     * - 生日
+     * - 事件发送者信息
      */
-    birthday?: string;
+    sender: Sender;
     /**
-     * - 登录天数
+     * - 是否为主人
+     * @default false
      */
-    login_day?: number;
+    isMaster: boolean;
     /**
-     * - 点赞数
+     * - 是否为管理员
+     * @default false
      */
-    vote_cnt?: number;
+    isAdmin: boolean;
     /**
-     * - 学校是否已核实
+     * - 是否为私聊
+     * @default false
      */
-    is_school_verified?: boolean;
+    isPrivate: boolean;
     /**
-     * - 年龄
-     * - 拓展字段
+     * - 是否为群聊
+     * @default false
      */
-    age?: number;
+    isGroup: boolean;
     /**
-     * - 性别
-     * - 拓展字段
+     * - 是否为频道
+     * @default false
      */
-    sex?: 'male' | 'female' | 'unknown';
-    ext?: {
-        /**
-         * 大会员
-         */
-        big_vip?: boolean;
-        /**
-         * 好莱坞/腾讯视频会员
-         */
-        hollywood_vip?: boolean;
-        /**
-         * QQ会员
-         */
-        qq_vip?: boolean;
-        /**
-         * QQ超级会员
-         */
-        super_vip?: boolean;
-        /**
-         * 是否已经赞过
-         */
-        voted?: boolean;
-    };
-}
-/**
- * - QQ群信息
- */
-export interface GroupInfo {
+    isGuild: boolean;
     /**
-     * - 群ID
+     * - 是否为群临时会话
+     * @default false
      */
-    group_id: string;
+    isGroupTemp: boolean;
     /**
-     * - 群名称
+     * - 日志函数字符串
      */
-    group_name: string;
+    logFnc: string;
     /**
-     * - 群备注
+     * - 日志用户字符串
      */
-    group_remark?: string;
+    logText: string;
     /**
-     * - 群主UID
+     * - 存储器 由开发者自行调用
      */
-    owner: string;
+    store: Map<string, any>;
     /**
-     * - 群管理员UID列表
+     * - 标准含义是代表原始事件文本，在karin是指经过karin处理后的事件文本
      */
-    admins: Array<string>;
+    raw_message: string;
     /**
-     * - 最大成员数
+     * - 回复函数
      */
-    max_member_count: number;
+    reply: Reply;
     /**
-     * - 当前成员数
+     * - 回复函数 由适配器实现，开发者不应该直接调用
      */
-    member_count: number;
+    replyCallback: replyCallback;
     /**
-     * - 群UIN
+     * - bot实现
      */
-    group_uin?: string;
+    bot: KarinAdapter;
 }
 /**
- * - 群成员信息
+ * - 消息事件基类
  */
-export interface GroupMemberInfo {
-    /**
-     * - 用户UID
-     */
-    uid: string;
+export interface KarinMessageEvent extends KarinEventType {
     /**
-     * - 用户UIN
+     * - 消息体
      */
-    uin: string;
-    /**
-     * - 用户昵称
-     */
-    nick: string;
+    event: 'message' | 'message_sent';
     /**
-     * - 年龄
-     */
-    age: number;
+       * - 消息ID
+       */
+    message_id: string;
     /**
-     * - 群内头衔
+     * - 消息序列号
      */
-    unique_title: string;
+    message_seq?: string;
     /**
-     * - 群内头衔过期时间
+     * - 原始消息文本
      */
-    unique_title_expire_time: number;
+    raw_message: string;
     /**
-     * - 群名片
+     * - 消息体元素
      */
-    card?: string;
+    elements: Array<KarinElement>;
     /**
-     * - 加群时间
+     * - 框架处理后的文本
      */
-    join_time?: number;
+    msg: string;
     /**
-     * - 最后活跃时间
+     * - 图片数组
      */
-    last_active_time?: number;
+    image: Array<string>;
     /**
-     * - 用户等级
+     * - AT数组
      */
-    level: number;
+    at: Array<string>;
     /**
-     * - 禁言时间
+     * - 是否AT机器人
      */
-    shut_up_time: number;
+    atBot: boolean;
     /**
-     * - 距离
+     * - 是否AT全体
      */
-    distance?: number;
+    atAll: boolean;
     /**
-     * - 荣誉列表
+     * - 文件元素
      */
-    honors?: Array<number>;
+    file: object;
     /**
-     * - 是否好友
+     * - 引用消息ID
      */
-    unfriendly?: boolean;
+    reply_id: string;
     /**
-     * - 是否可修改群名片
+     * - 消息别名
      */
-    card_changeable?: boolean;
+    alias: string;
 }
 /**
- * 群荣誉信息
+ * - 基础通知事件接口，包含所有共同属性
  */
-export interface GroupHonorInfo {
-    /**
-     * - 荣誉成员uid
-     */
-    uid: string;
-    /**
-     * - 荣誉成员uin
-     */
-    uin: string;
-    /**
-     * - 荣誉成员昵称
-     */
-    nick: string;
-    /**
-     * - 荣誉名称
-     */
-    honor_name: string;
-    /**
-     * - 荣誉图标url
-     */
-    avatar: string;
-    /**
-     * - 荣誉id
-     */
-    id: number;
-    /**
-     * - 荣誉描述
-     */
-    description: string;
+export interface KarinNoticeEventBase extends KarinEventType {
+    event: 'notice';
+}
+/**
+ * - 辅助类型，用于生成 KarinNoticeEvent 的联合类型
+ */
+export type NoticeEvent<T extends keyof NoticeType> = KarinNoticeEventBase & {
+    sub_event: T;
+    content: NoticeType[T];
+};
+/**
+ * - 通知事件基类
+ */
+export type KarinNoticeEvent = NoticeEvent<'friend_poke'> | NoticeEvent<'friend_recall'> | NoticeEvent<'friend_file_uploaded'> | NoticeEvent<'group_poke'> | NoticeEvent<'group_card_changed'> | NoticeEvent<'group_member_unique_title_changed'> | NoticeEvent<'group_essence_changed'> | NoticeEvent<'group_recall'> | NoticeEvent<'group_member_increase'> | NoticeEvent<'group_member_decrease'> | NoticeEvent<'group_admin_changed'> | NoticeEvent<'group_member_ban'> | NoticeEvent<'group_sign'> | NoticeEvent<'group_whole_ban'> | NoticeEvent<'group_file_uploaded'> | NoticeEvent<'group_message_reaction'>;
+/**
+ * - 请求事件基类
+ */
+export interface KarinRequestEventBase extends KarinEventType {
+    event: 'request';
 }
+/**
+ * - 辅助类型，用于生成 KarinRequestEvent 的联合类型
+ */
+export type RequestEvent<T extends keyof RequestType> = KarinRequestEventBase & {
+    sub_event: T;
+    content: RequestType[T];
+};
+/**
+ * - 请求事件基类
+ */
+export type KarinRequestEvent = RequestEvent<'friend_apply'> | RequestEvent<'group_apply'> | RequestEvent<'invited_group'>;
 export interface EMap {
-    message: KarinMessage;
-    notice: KarinNotice;
-    request: KarinRequest;
-    message_sent: KarinMessage;
+    message: KarinMessageEvent;
+    notice: KarinNoticeEvent;
+    request: KarinRequestEvent;
+    message_sent: KarinMessageEvent;
     meta_event: any;
 }
-export type E<T extends keyof EMap> = EMap[T];
-export type EType = KarinMessage | KarinNotice | KarinRequest;
+export type EType = KarinMessageEvent | KarinNoticeEvent | KarinRequestEvent;
 /**
  * 根据accept函数是否存在来决定e的类型
  */
 export type EventType<T> = T extends {
-    accept: (e: any) => Promise<void>;
-} ? KarinNotice | KarinRequest : KarinMessage;
+    accept: (e: KarinNoticeEvent | KarinRequestEvent) => Promise<void>;
+} ? KarinNoticeEvent | KarinRequestEvent : KarinMessageEvent;

package/lib/types/index.d.ts

@@ -7,3 +7,4 @@ export * from './onebots11.js';
 export * from './render.js';
 export * from './plugin.js';
 export * from './reply.js';
+export * from './api.js';

package/lib/types/index.js

@@ -7,3 +7,4 @@ export * from './onebots11.js'
 export * from './render.js'
 export * from './plugin.js'
 export * from './reply.js'
+export * from './api.js'

package/lib/types/plugin.d.ts

@@ -1,8 +1,7 @@
-/// <reference types="node" />
 import schedule from 'node-schedule';
 import { KarinNodeElement } from './element.js';
 import { Reply, replyCallback } from './reply.js';
-import { EventType, Event, Permission, SubEvent } from './event.js';
+import { EventType, Event, Permission, SubEvent, KarinMessageEvent, KarinNoticeEvent, KarinRequestEvent } from './event.js';
 /**
  * - 插件根目录名称
  * - 例如: karin-plugin-example
@@ -88,7 +87,7 @@ export interface PluginHandler {
     /**
      * - handler的处理方法名称
      */
-    fnc: string;
+    fnc: string | Function;
     /**
      * - handler优先级 不填默认为主优先度
      */
@@ -164,7 +163,7 @@ export interface PluginType {
      * - 上报事件
      * - 根据上报中的event字段来获取e的事件类型
      */
-    e: EventType<this>;
+    e: KarinMessageEvent | KarinNoticeEvent | KarinRequestEvent;
     /**
      * - 快速回复
      */
@@ -259,7 +258,7 @@ export interface PluginApps {
     /**
      * - accept函数存在
      */
-    accept: boolean;
+    accept: boolean | Function;
     /**
      * - 命令规则
      */

package/lib/utils/button.d.ts

@@ -1,2 +1,2 @@
-import { KarinMessage } from '../event/message.js';
-export declare const button: (e: KarinMessage) => Promise<any>;
+import { KarinMessageEvent } from '../types/index.js';
+export declare const button: (e: KarinMessageEvent) => Promise<any>;

package/lib/utils/common.d.ts

@@ -1,4 +1,3 @@
-/// <reference types="node" />
 import { AxiosRequestConfig } from 'axios';
 import { Readable } from 'stream';
 import { fs } from '../modules.js';
@@ -26,7 +25,7 @@ export declare const common: {
      * @param type 请求类型
      * @param param axios参数
      */
-    axios(url: string, type?: 'get' | 'post', param?: AxiosRequestConfig): Promise<any | null>;
+    axios(url: string, type?: "get" | "post", param?: AxiosRequestConfig): Promise<any | null>;
     /**
      * 递归创建目录
      * @param dirname - 要创建的文件夹路径

package/lib/utils/config.d.ts

@@ -21,7 +21,7 @@ export declare const config: {
     /**
      * 超时时间
      */
-    timeout(type?: 'ws' | 'grpc'): number;
+    timeout(type?: "ws" | "grpc"): number;
     /**
      * Redis 配置
      * 采用实时读取优化性能
@@ -29,7 +29,6 @@ export declare const config: {
     readonly redis: Redis;
     /**
      * 主人列表
-     * @returns {string[]}
      */
     readonly master: string[];
     /**
@@ -58,14 +57,14 @@ export declare const config: {
     /**
      * 获取配置yaml
      */
-    getYaml(type: 'defSet' | 'config', name: string, isWatch?: boolean): any;
+    getYaml(type: "defSet" | "config", name: string, isWatch?: boolean): any;
     /**
      * 监听配置文件
      * @param {'defSet'|'config'} type 类型
      * @param {string} name 文件名称 不带后缀
      * @param {string} file 文件路径
      */
-    watch(type: 'defSet' | 'config', name: string, file: string): Promise<true | undefined>;
+    watch(type: "defSet" | "config", name: string, file: string): Promise<true | undefined>;
     change_App(): Promise<void>;
     change_config(): Promise<void>;
     change_group(): Promise<void>;

package/lib/utils/config.js

@@ -90,7 +90,6 @@ export const config = new (class Cfg {
 
   /**
      * 主人列表
-     * @returns {string[]}
      */
   get master () {
     return this.Config.master || []
@@ -130,9 +129,24 @@ export const config = new (class Cfg {
     const config = this.getYaml('config', 'config', true)
     const defSet = this.getYaml('defSet', 'config', false)
     const data = { ...defSet, ...config }
+    const Config = {
+      ...data,
+      WhiteList: {
+        users: data.WhiteList.users.map((i) => String(i)),
+        groups: data.WhiteList.groups.map((i) => String(i)),
+        GroupMsgLog: data.WhiteList.GroupMsgLog.map((i) => String(i)),
+      },
+      BlackList: {
+        users: data.BlackList.users.map((i) => String(i)),
+        groups: data.BlackList.groups.map((i) => String(i)),
+        GroupMsgLog: data.BlackList.GroupMsgLog.map((i) => String(i)),
+      },
+      master: data.master.map((i) => String(i)),
+      admin: data.admin.map((i) => String(i)),
+    }
     /** 缓存 */
-    this.change.set(key, data)
-    return data
+    this.change.set(key, Config)
+    return Config
   }
 
   /**

package/lib/utils/exec.d.ts

@@ -11,12 +11,12 @@ export declare const exec: (cmd: string, log?: boolean, options?: {
     /**
      * - 执行状态
      */
-    status: 'ok' | 'failed';
+    status: "ok" | "failed";
     /**
      * - 错误信息
      */
     error: Error | null;
-    stdout: string | '';
-    stderr: string | '';
+    stdout: string | "";
+    stderr: string | "";
 }>;
 export default exec;

package/lib/utils/ffmpeg.d.ts

@@ -5,8 +5,8 @@ export default function ffmpeg(): Promise<false | ((cmd: string, log?: boolean,
     cwd: string;
     encoding: string;
 }) => Promise<{
-    status: "failed" | "ok";
+    status: "ok" | "failed";
     error: Error | null;
-    stdout: string;
-    stderr: string;
+    stdout: string | "";
+    stderr: string | "";
 }>)>;