node-karin 0.10.7 → 0.11.0

package/lib/event/handler/review.d.ts

@@ -1,4 +1,4 @@
-import { KarinMessageType, PluginApps, GroupCfg, KarinEventTypes } from '../../types/index.js';
+import { KarinMessageType, GroupCfg, KarinEventTypes, PluginCommandInfoType, PluginAcceptInfoType } from '../../types/index.js';
 /**
  * 事件拦截器
  * 利用可执行函数的特性，热更新所有拦截器
@@ -19,37 +19,37 @@ export declare const review: {
     GroupEnable: (e: KarinEventTypes) => boolean;
     UserEnable: (e: KarinEventTypes) => boolean;
     GroupMsgPrint: (e: KarinEventTypes) => boolean;
-    PluginEnable: (app: PluginApps, config: GroupCfg) => boolean;
+    PluginEnable: (app: PluginCommandInfoType | PluginAcceptInfoType, config: GroupCfg) => boolean;
     Private: () => boolean;
     main(): void;
     /**
      * 群聊黑白名单 允许哪个群触发事件
      */
-    "__#1@#GroupEnable"(): true | undefined;
+    "__#11@#GroupEnable"(): true | undefined;
     /**
      * 用户黑白名单 允许那个用户触发事件
      */
-    "__#1@#UserEnable"(): true | undefined;
+    "__#11@#UserEnable"(): true | undefined;
     /**
      * 群聊事件日志 是否打印
      */
-    "__#1@#GroupMsgPrint"(): true | undefined;
+    "__#11@#GroupMsgPrint"(): true | undefined;
     /**
      * 黑白名单插件 哪个插件可以被触发
      */
-    "__#1@#PluginEnable"(): boolean;
+    "__#11@#PluginEnable"(): boolean;
     /** 群聊cd */
-    "__#1@#CD"(): true | undefined;
+    "__#11@#CD"(): true | undefined;
     /**
      * 响应模式
      */
-    "__#1@#mode"(): true | undefined;
+    "__#11@#mode"(): true | undefined;
     /**
      * 前缀、别名
      */
-    "__#1@#alias"(): true | undefined;
+    "__#11@#alias"(): true | undefined;
     /**
      * 私聊功能
      */
-    "__#1@#Private"(): true | undefined;
+    "__#11@#Private"(): true | undefined;
 };

package/lib/event/handler/review.js

@@ -1,4 +1,5 @@
 import { logger, config } from '../../utils/index.js';
+import { pluginLoader } from '../../core/index.js';
 /**
  * 事件拦截器
  * 利用可执行函数的特性，热更新所有拦截器
@@ -193,36 +194,30 @@ export const review = new (class Handler {
         /** 同时启用 */
         if (this.App.GroupConfig.enable && this.App.GroupConfig.disable) {
             this.PluginEnable = (app, config) => {
+                const plugin = pluginLoader.plugin[app.key];
                 /** 白名单不为空 */
                 if (Array.isArray(config.enable) && config.enable.length) {
                     /** 插件包是否处于功能白名单 */
-                    if (config.enable.includes(app.file.dir))
-                        return true;
-                    /** 插件是否处于功能白名单 */
-                    if (config.enable.includes(`${app.file.dir}/${app.file.name}`))
-                        return true;
-                    /** 插件名称是否处于功能白名单 */
-                    if (config.enable.includes(app.name))
-                        return true;
+                    for (const key of config.enable) {
+                        if (key.plugin === plugin.plugin)
+                            return true;
+                        if (key.name === plugin.file || key.name === app.name)
+                            return true;
+                    }
                     logger.debug(logger.green(`[功能白名单] 插件名称 [${app.name}] 不存在功能白名单中`));
                     return false;
                 }
                 /** 白名单为空 检查黑名单是否为空 */
                 if (Array.isArray(config.disable) && config.disable.length) {
-                    /** 插件包是否处于功能黑名单 */
-                    if (config.disable.includes(app.file.dir)) {
-                        logger.debug(logger.red(`[功能黑名单] 插件包 [${app.file.dir}] 处于功能黑名单`));
-                        return false;
-                    }
-                    /** 插件是否处于功能黑名单 */
-                    if (config.disable.includes(`${app.file.dir}/${app.file.name}`)) {
-                        logger.debug(logger.red(`[功能黑名单] 插件 [${app.file.dir}/${app.file.name}] 处于功能黑名单`));
-                        return false;
-                    }
-                    /** 插件名称是否处于功能黑名单 */
-                    if (config.disable.includes(app.name)) {
-                        logger.debug(logger.red(`[功能黑名单] 插件名称 [${app.name}] 处于功能黑名单`));
-                        return false;
+                    for (const key of config.disable) {
+                        if (key.plugin === plugin.plugin) {
+                            logger.debug(logger.red(`[功能黑名单] 插件包 [${app.name}] 处于功能黑名单`));
+                            return false;
+                        }
+                        if (key.name === plugin.file || key.name === app.name) {
+                            logger.debug(logger.red(`[功能黑名单] 插件 [${app.name}] 处于功能黑名单`));
+                            return false;
+                        }
                     }
                     return true;
                 }
@@ -234,13 +229,14 @@ export const review = new (class Handler {
         /** 白名单启用 */
         if (this.App.GroupConfig.enable) {
             this.PluginEnable = (app, config) => {
+                const plugin = pluginLoader.plugin[app.key];
                 if (Array.isArray(config.enable) && config.enable.length) {
-                    if (config.enable.includes(app.file.dir))
-                        return true;
-                    if (config.enable.includes(`${app.file.dir}/${app.file.name}`))
-                        return true;
-                    if (config.enable.includes(app.name))
-                        return true;
+                    for (const key of config.enable) {
+                        if (key.plugin === plugin.plugin)
+                            return true;
+                        if (key.name === plugin.file || key.name === app.name)
+                            return true;
+                    }
                     logger.debug(logger.green(`[功能白名单] 插件名称 [${app.name}] 不存在功能白名单中`));
                     return false;
                 }
@@ -251,18 +247,17 @@ export const review = new (class Handler {
         /** 黑名单启用 */
         if (this.App.GroupConfig.disable) {
             this.PluginEnable = (app, config) => {
+                const plugin = pluginLoader.plugin[app.key];
                 if (Array.isArray(config.disable) && config.disable.length) {
-                    if (config.disable.includes(app.file.dir)) {
-                        logger.debug(logger.red(`[功能黑名单] 插件包 [${app.file.dir}] 处于功能黑名单`));
-                        return false;
-                    }
-                    if (config.disable.includes(`${app.file.dir}/${app.file.name}`)) {
-                        logger.debug(logger.red(`[功能黑名单] 插件 [${app.file.dir}/${app.file.name}] 处于功能黑名单`));
-                        return false;
-                    }
-                    if (config.disable.includes(app.name)) {
-                        logger.debug(logger.red(`[功能黑名单] 插件名称 [${app.name}] 处于功能黑名单`));
-                        return false;
+                    for (const key of config.disable) {
+                        if (key.plugin === plugin.plugin) {
+                            logger.debug(logger.red(`[功能黑名单] 插件包 [${app.name}] 处于功能黑名单`));
+                            return false;
+                        }
+                        if (key.name === plugin.file || key.name === app.name) {
+                            logger.debug(logger.red(`[功能黑名单] 插件 [${app.name}] 处于功能黑名单`));
+                            return false;
+                        }
                     }
                     return true;
                 }

package/lib/types/config/config.d.ts

@@ -361,9 +361,19 @@ export interface GroupCfg {
     /**
      * 白名单插件、功能，只有在白名单中的插件、功能才会响应
      */
-    enable: string[];
+    enable: {
+        /** 插件包名称 */
+        plugin: string;
+        /** 插件文件名或插件名称 */
+        name: string;
+    }[];
     /**
      * 黑名单插件、功能，黑名单中的插件、功能不会响应
      */
-    disable: string[];
+    disable: {
+        /** 插件包名称 */
+        plugin: string;
+        /** 插件文件名或插件名称 */
+        name: string;
+    }[];
 }

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

@@ -16,7 +16,7 @@ export interface Contact {
     /**
      * - 事件来源场景
      */
-    scene: Scene;
+    scene: `${Scene}`;
     /**
      * - 事件来源id 群号或者用户id
      */

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

@@ -139,122 +139,25 @@ export type EventToSubEvent = {
     [EventType.Request]: RequestSubType;
 };
 /**
- * 组合事件类型枚举
+ * 所有消息事件类型
  */
-export declare const enum CombinedEventType {
-    /**
-     * - 消息事件: 群消息
-     */
-    MessageGroupMessage = "message.group_message",
-    /**
-     * - 消息事件: 私聊消息
-     */
-    MessagePrivateMessage = "message.private_message",
-    /**
-     * - 消息事件: 频道消息
-     */
-    MessageGuildMessage = "message.guild_message",
-    /**
-     * - 消息事件: 附近消息
-     */
-    MessageNearby = "message.nearby",
-    /**
-     * - 消息事件: 陌生人消息
-     */
-    MessageStranger = "message.stranger",
-    /**
-     * - 通知事件: 私聊戳一戳
-     */
-    NoticePrivatePoke = "notice.private_poke",
-    /**
-     * - 通知事件: 私聊撤回消息
-     */
-    NoticePrivateRecall = "notice.private_recall",
-    /**
-     * - 通知事件: 私聊发送文件
-     */
-    NoticePrivateFileUploaded = "notice.private_file_uploaded",
-    /**
-     * - 通知事件: 群聊戳一戳
-     */
-    NoticeGroupPoke = "notice.group_poke",
-    /**
-     * - 通知事件: 群聊名片变动
-     */
-    NoticeGroupCardChanged = "notice.group_card_changed",
-    /**
-     * - 通知事件: 群聊成员头衔变动
-     */
-    NoticeGroupMemberUniqueTitleChanged = "notice.group_member_unique_title_changed",
-    /**
-     * - 通知事件: 群聊精华消息变动
-     */
-    NoticeGroupEssenceChanged = "notice.group_essence_changed",
-    /**
-     * - 通知事件: 群聊撤回消息
-     */
-    NoticeGroupRecall = "notice.group_recall",
-    /**
-     * - 通知事件: 群聊成员增加
-     */
-    NoticeGroupMemberIncrease = "notice.group_member_increase",
-    /**
-     * - 通知事件: 群聊成员减少
-     */
-    NoticeGroupMemberDecrease = "notice.group_member_decrease",
-    /**
-     * - 通知事件: 群聊管理员变动
-     */
-    NoticeGroupAdminChanged = "notice.group_admin_changed",
-    /**
-     * - 通知事件: 群聊成员禁言
-     */
-    NoticeGroupMemberBan = "notice.group_member_ban",
-    /**
-     * - 通知事件: 群聊签到
-     */
-    NoticeGroupSignIn = "notice.group_sign_in",
-    /**
-     * - 通知事件: 群聊全员禁言
-     */
-    NoticeGroupWholeBan = "notice.group_whole_ban",
-    /**
-     * - 通知事件: 群聊发送文件
-     */
-    NoticeGroupFileUploaded = "notice.group_file_uploaded",
-    /**
-     * - 通知事件: 群聊消息表情动态回应
-     */
-    NoticeGroupMessageReaction = "notice.group_message_reaction",
-    /**
-     * - 请求事件: 好友申请
-     */
-    RequestPrivateApply = "request.private_apply",
-    /**
-     * - 请求事件: 群聊申请
-     */
-    RequestGroupApply = "request.group_apply",
-    /**
-     * - 请求事件: 邀请入群
-     */
-    RequestInvitedGroup = "request.invited_group"
-}
+export type AllMessageSubType = `${EventType.Message}` | `${EventType.Message}.${MessageSubType}`;
 /**
- * - 消息监听事件
+ * 所有通知事件类型
  */
-export type MessageListenEvent = 'message' | 'message.group_message' | 'message.private_message' | 'message.guild_message' | 'message.nearby' | 'message.stranger';
+export type AllNoticeSubType = `${EventType.Notice}` | `${EventType.Notice}.${NoticeSubType}`;
 /**
- * - 通知监听事件
+ * 所有请求事件类型
  */
-export type NoticeListenEvent = 'notice' | 'notice.private_poke' | 'notice.private_recall' | 'notice.private_file_uploaded' | 'notice.group_poke' | 'notice.group_card_changed' | 'notice.group_member_unique_title_changed' | 'notice.group_essence_changed' | 'notice.group_recall' | 'notice.group_member_increase' | 'notice.group_member_decrease' | 'notice.group_admin_changed' | 'notice.group_member_ban' | 'notice.group_sign_in' | 'notice.group_whole_ban' | 'notice.group_file_uploaded' | 'notice.group_message_reaction';
+export type AllRequestSubType = `${EventType.Request}` | `${EventType.Request}.${RequestSubType}`;
 /**
- * - 请求监听事件
+ * 所有组合事件类型
  */
-export type RequestListenEvent = 'request' | 'request.private_apply' | 'request.group_apply' | 'request.invited_group';
+export type CombinedEventType = AllMessageSubType | AllNoticeSubType | AllRequestSubType;
 /**
  * 所有监听事件
  */
-export type AllListenEvent = MessageListenEvent | NoticeListenEvent | RequestListenEvent;
+export type AllListenEvent = `${EventType}` | `${CombinedEventType}`;
 /**
  * 事件基类定义
  */

package/lib/types/index.d.ts

@@ -5,6 +5,7 @@ export * from './element/qqbot.js';
 export * from './event/index.js';
 export * from './logger/logger.js';
 export * from './render/render.js';
+export * from './plugin/app.js';
 export * from './plugin/plugin.js';
 export * from './event/reply.js';
 export * from './adapter/api.js';

package/lib/types/index.js

@@ -5,6 +5,7 @@ export * from './element/qqbot.js'
 export * from './event/index.js'
 export * from './logger/logger.js'
 export * from './render/render.js'
+export * from './plugin/app.js'
 export * from './plugin/plugin.js'
 export * from './event/reply.js'
 export * from './adapter/api.js'

package/lib/types/plugin/app.d.ts

@@ -0,0 +1,71 @@
+import { MiddlewareType } from '../../core/karin/karin.js';
+import { AllMessageSubType, AllNoticeSubType, AllRequestSubType, KarinMessageType, KarinNoticeType, KarinRequestType, NewMessagePlugin, Permission } from '../../types/index.js';
+export declare const enum AppType {
+    Command = "command",
+    Task = "task",
+    Handler = "handler",
+    Button = "button",
+    Accept = "accept",
+    Use = "use"
+}
+interface AppInfo {
+    /** 实现方法 */
+    fn: Function;
+    /** 插件名称 */
+    name: string;
+    /** 插件类型 */
+    type: `${AppType}`;
+    /** 插件优先级 */
+    rank: number;
+    /** 执行方法打印日志函数 */
+    log: Function;
+}
+/** command规则集类型 */
+export interface CommandInfo extends AppInfo {
+    fn: (e: KarinMessageType) => Promise<boolean>;
+    /** 插件执行方法名称 */
+    fnname: string;
+    type: `${AppType.Command}`;
+    /** 监听事件 */
+    event: `${AllMessageSubType}`;
+    /** 正则 */
+    reg: RegExp;
+    /** 权限 */
+    perm: `${Permission}`;
+    /** class */
+    data: NewMessagePlugin | '';
+}
+/** task规则集类型 */
+export interface TaskInfo extends Omit<AppInfo, 'rank'> {
+    type: `${AppType.Task}`;
+    /** 任务名称 */
+    fnname: string;
+    /** cron表达式 */
+    cron: string;
+}
+/** handler规则集类型 */
+export interface HandlerInfo extends Omit<AppInfo, 'log'> {
+    type: `${AppType.Handler}`;
+    /** 入口秘钥 */
+    key: string;
+}
+/** button规则集类型 */
+export interface ButtonInfo extends AppInfo {
+    type: `${AppType.Button}`;
+    /** 正则 */
+    reg: RegExp;
+}
+/** accept规则集类型 */
+export interface AcceptInfo extends AppInfo {
+    fn: (e: KarinNoticeType | KarinRequestType) => Promise<boolean>;
+    type: `${AppType.Accept}`;
+    /** 监听事件 */
+    event: `${AllNoticeSubType}` | `${AllRequestSubType}`;
+}
+/** use规则集类型 */
+export interface UseInfo extends Omit<AppInfo, 'log'> {
+    type: `${AppType.Use}`;
+    /** 中间件类型key */
+    key: `${MiddlewareType}`;
+}
+export {};

package/lib/types/plugin/app.js

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

package/lib/types/plugin/plugin.d.ts

@@ -1,7 +1,8 @@
 import schedule from 'node-schedule';
 import { Plugin } from '../../core/index.js';
 import { Reply, replyCallback, replyForward } from '../event/reply.js';
-import { KarinNoticeType, KarinRequestType, AllListenEvent, KarinMessageType, PermissionType } from '../event/index.js';
+import { KarinNoticeType, KarinRequestType, AllListenEvent, KarinMessageType, PermissionType, AllMessageSubType, Contact, AllNoticeSubType, AllRequestSubType } from '../event/index.js';
+import { KarinElement } from '../element/element.js';
 /**
  * - 插件根目录名称
  * - 例如: karin-plugin-example
@@ -15,6 +16,190 @@ export type dirName = `karin-plugin-${string}` | string;
  * - 例如: index.js index.ts
  */
 export type fileName = `${string}.js` | `${string}.ts`;
+/**
+ * 插件类型枚举
+ */
+export declare const enum AppsType {
+    /** git插件 */
+    Git = "git",
+    /** npm插件 */
+    Npm = "npm",
+    /** 单个app插件 */
+    Js = "js"
+}
+/**
+ * 插件实现方法类型
+ */
+export declare const enum MethodType {
+    /** 函数 */
+    Function = "function",
+    /** 类 */
+    Class = "class"
+}
+/**
+ * plugin基本信息
+ */
+export interface PluginInfoType {
+    [key: string]: {
+        /** 插件包类型 */
+        type: `${AppsType}`;
+        /** 插件包名称 例: `karin-plugin-example` `@karinjs/adapter-qqbot` */
+        plugin: string;
+        /** 插件路径 在type为js下，path为空 */
+        path: string;
+        /** 插件文件名称 index.js index.ts */
+        file: string;
+    };
+}
+/**
+ * Command规则集信息
+ */
+export interface PluginCommandInfoType {
+    /** 插件基本信息的映射key */
+    key: string;
+    /** 插件包名称 */
+    name: string;
+    /** 插件正则 */
+    reg: RegExp;
+    /** 插件执行方法 */
+    fn: (e: KarinMessageType) => Promise<boolean>;
+    /** 插件执行方法名称 */
+    fnname: string;
+    /** 插件类型 */
+    type: `${MethodType}`;
+    /** 在type为class的时候 data为class 否则为空字符串 */
+    data: (() => PluginType) | undefined;
+    /** 插件执行权限 */
+    perm: `${PermissionType}`;
+    /** 执行打印日志方法 */
+    log: Function;
+    /** 监听的子事件 高于父事件 */
+    event: AllMessageSubType;
+    /** 优先级 */
+    rank: number;
+}
+/**
+ * accept规则集信息
+ */
+export interface PluginAcceptInfoType {
+    /** 插件基本信息的映射key */
+    key: string;
+    /** 插件包名称 */
+    name: string;
+    /** 插件执行方法 */
+    fn: (e: KarinNoticeType | KarinRequestType) => Promise<boolean>;
+    /** 优先级 */
+    rank: number;
+    /** 监听事件 */
+    event: AllNoticeSubType | AllRequestSubType;
+    /** 执行打印日志方法 */
+    log: Function;
+}
+/**
+ * task规则集信息
+ */
+export interface PluginTaskInfoType {
+    /** 插件基本信息的映射key */
+    key: string;
+    /** 插件包名称 */
+    name: string;
+    /** 任务名称 */
+    taskname: string;
+    /** cron表达式 */
+    cron: string;
+    /** 任务执行方法 */
+    fn: Function;
+    /** 在type为class的时候 data为class 否则为空字符串 */
+    data: (() => PluginType) | undefined;
+    /** 执行打印日志方法 */
+    log: Function;
+    /** 停止函数 */
+    schedule: schedule.Job;
+}
+/**
+ * button规则集信息
+ */
+export interface PluginButtonInfoType {
+    /** 插件基本信息的映射key */
+    key: string;
+    /** 插件包名称 */
+    name: string;
+    /** 插件正则 */
+    reg: RegExp;
+    /** 插件执行方法 */
+    fn: (reject: Function, e?: KarinMessageType) => Promise<any>;
+    /** 优先级 */
+    rank: number;
+}
+/**
+ * handler规则集信息
+ */
+export interface PluginHandlerInfoType {
+    /** 插件基本信息的映射key */
+    key: string;
+    /** 插件包名称 */
+    name: string;
+    /** handler的处理方法 */
+    fn: (args: any, reject: (msg?: string) => void) => Promise<any>;
+    /** 优先级 */
+    rank: number;
+}
+/**
+ * 中间件规则集信息
+ */
+export interface PluginMiddlewareInfoType {
+    /** 初始化消息前 */
+    recvMsg: Array<{
+        /** 插件基本信息的映射key */
+        key: string;
+        /** 插件包名称 */
+        name: string;
+        /** 插件执行方法 */
+        fn: (
+        /** 消息事件方法 */
+        e: KarinMessageType, 
+        /** 是否继续执行插件 */
+        next: Function) => Promise<boolean>;
+        /** 优先级 */
+        rank: number;
+    }>;
+    /** 回复消息前 */
+    replyMsg: Array<{
+        /** 插件基本信息的映射key */
+        key: string;
+        /** 插件包名称 */
+        name: string;
+        /** 插件执行方法 */
+        fn: (
+        /** 消息事件方法 */
+        e: KarinMessageType, 
+        /** 回复的消息体 */
+        element: KarinElement[], 
+        /** 是否继续执行插件 */
+        next: Function) => Promise<boolean>;
+        /** 优先级 */
+        rank: number;
+    }>;
+    /** 发送主动消息前 */
+    sendMsg: Array<{
+        /** 插件基本信息的映射key */
+        key: string;
+        /** 插件包名称 */
+        name: string;
+        /** 插件执行方法 */
+        fn: (
+        /** 发送的bot */
+        uid: string, 
+        /** 发送目标 */
+        contact: Contact, 
+        /** 发送的消息体 */
+        element: KarinElement[], 
+        /** 是否继续执行插件 */
+        next: Function) => Promise<boolean>;
+        /** 优先级 */
+        rank: number;
+    }>;
+}
 /**
  * 上下文状态
  */
@@ -45,7 +230,11 @@ export interface PluginRule {
     /**
      * - 监听子事件
      */
-    event?: AllListenEvent;
+    event?: AllMessageSubType;
+    /**
+     * - 优先级 默认为10000
+     */
+    priority?: number;
     /**
      * 权限
      */
@@ -141,11 +330,6 @@ export interface PluginType {
      * - 插件名称
      */
     name: string;
-    /**
-     * - 插件描述
-     * @deprecated 请使用desc
-     */
-    dsc: string;
     /**
      * - 插件描述
      */
@@ -153,7 +337,7 @@ export interface PluginType {
     /**
      * - 监听事件 默认为message
      */
-    event: AllListenEvent;
+    event: AllMessageSubType;
     /**
      * - 优先级 默认为10000
      */
@@ -166,10 +350,6 @@ export interface PluginType {
      * - 命令规则
      */
     rule: Array<PluginRule>;
-    /**
-     * - 按钮
-     */
-    button: Array<PluginButton>;
     /**
      * - handler
      */