node-karin 0.10.7 → 0.11.1

package/config/defSet/group.yaml

@@ -11,10 +11,10 @@ default:
   alias:
     - k
 
-  # 白名单插件、功能，只有在白名单中的插件、功能才会响应
+  # 白名单插件、功能，只有在白名单中的插件、功能才会响应 {plugin: "插件包名", name: "文件名称或插件名称"}
   enable: []
 
-  # 黑名单插件、功能，黑名单中的插件、功能不会响应
+  # 黑名单插件、功能，黑名单中的插件、功能不会响应 {plugin: "插件包名", name: "文件名称或插件名称"}
   disable: []
 
 # 单个Bot默认配置
@@ -30,10 +30,10 @@ Bot.self_id:
   alias:
     - k
 
-  # 白名单插件、功能，只有在白名单中的插件、功能才会响应
+  # 白名单插件、功能，只有在白名单中的插件、功能才会响应 {plugin: "插件包名", name: "文件名称或插件名称"}
   enable: []
 
-  # 黑名单插件、功能，黑名单中的插件、功能不会响应
+  # 黑名单插件、功能，黑名单中的插件、功能不会响应 {plugin: "插件包名", name: "文件名称或插件名称"}
   disable: []
 
 # 单个Bot单个群配置
@@ -49,8 +49,8 @@ Bot.self_id.group_id:
   alias:
     - k
 
-  # 白名单插件、功能，只有在白名单中的插件、功能才会响应
+  # 白名单插件、功能，只有在白名单中的插件、功能才会响应 {plugin: "插件包名", name: "文件名称或插件名称"}
   enable: []
 
-  # 黑名单插件、功能，黑名单中的插件、功能不会响应
+  # 黑名单插件、功能，黑名单中的插件、功能不会响应 {plugin: "插件包名", name: "文件名称或插件名称"}
   disable: []

package/lib/adapter/onebot/11/convert.js

@@ -63,7 +63,7 @@ function fileToBase64(file, bot) {
         return file;
     const list = ['127.0.0.1', 'localhost'];
     const url = new URL(bot.adapter.connect);
-    return list.includes(url.hostname) ? `base64://${fs.readFileSync(file).toString('base64')}` : file;
+    return list.includes(url.hostname) ? file : `base64://${fs.readFileSync(file.replace('file://', '')).toString('base64')}`;
 }
 /**
    * karin转onebot11

package/lib/core/index.d.ts

@@ -3,7 +3,7 @@ export * from './init/init.js';
 export * from './karin/karin.js';
 export * from './listener/listener.js';
 export * from './plugin/base.js';
-export * from './plugin/app.js';
+export * from '../types/plugin/app.js';
 export * from './plugin/loader.js';
 export * from './process/process.js';
 export * from './server/server.js';

package/lib/core/index.js

@@ -3,7 +3,7 @@ export * from './init/init.js'
 export * from './karin/karin.js'
 export * from './listener/listener.js'
 export * from './plugin/base.js'
-export * from './plugin/app.js'
+export * from '../types/plugin/app.js'
 export * from './plugin/loader.js'
 export * from './process/process.js'
 export * from './server/server.js'

package/lib/core/karin/karin.d.ts

@@ -1,7 +1,18 @@
-import { Contact, PluginApps, KarinElement, KarinMessage, KarinRenderType, PermissionType, RenderResult, NoticeListenEvent, RequestListenEvent, KarinNoticeType, KarinRequestType } from '../../types/index.js';
+import { Contact, KarinElement, KarinMessage, KarinRenderType, PermissionType, RenderResult, KarinNoticeType, KarinRequestType, KarinMessageType, AllMessageSubType, CommandInfo, TaskInfo, HandlerInfo, AcceptInfo, UseInfo, AllNoticeSubType, AllRequestSubType } from '../../types/index.js';
 type FncFunction = (e: KarinMessage) => Promise<boolean>;
 type FncElement = string | KarinElement | Array<KarinElement>;
-export interface OptionsCommand {
+/**
+ * 中间件类型
+ */
+export declare const enum MiddlewareType {
+    /** 收到消息后 */
+    ReceiveMsg = "recvMsg",
+    /** 回复消息前 */
+    ReplyMsg = "replyMsg",
+    /** 发送主动消息前 */
+    SendMsg = "sendMsg"
+}
+export interface Options {
     /**
      * - 插件名称 不传则使用 插件名称:函数名
      */
@@ -11,17 +22,23 @@ export interface OptionsCommand {
      * @default 10000
      */
     priority?: number;
-    /**
-     * - 权限
-     * @default 'all'
-     */
-    permission?: PermissionType;
     /**
      * - 打印日志
      * @default false
      */
     log?: boolean | Function;
 }
+export interface OptionsCommand extends Options {
+    /**
+     * - 监听事件
+     */
+    event?: `${AllMessageSubType}`;
+    /**
+     * - 权限
+     * @default 'all'
+     */
+    permission?: PermissionType;
+}
 export interface OptionsElement extends OptionsCommand {
     /**
      * - 是否加上at 仅在群聊中有效
@@ -53,61 +70,41 @@ export declare class Karin {
     constructor();
     /**
     * @param reg - 正则表达式
-    * @param fnc - 函数
+    * @param fn - 函数
     * @param options - 选项
     */
-    command(reg: string | RegExp, fnc: FncFunction, options?: OptionsCommand): PluginApps;
+    command(reg: string | RegExp, fn: FncFunction, options?: OptionsCommand): CommandInfo;
     /**
      * @param reg - 正则表达式
      * @param element - 字符串或者KarinElement、KarinElement数组
      * @param options - 选项
      */
-    command(reg: string | RegExp, element: FncElement, options?: OptionsElement): PluginApps;
+    command(reg: string | RegExp, element: FncElement, options?: OptionsElement): CommandInfo;
     /**
      * - 构建定时任务
      * @param name - 任务名称
      * @param cron - cron表达式
-     * @param fnc - 执行函数
+     * @param fn - 执行函数
      * @param options - 选项
      */
-    task(name: string, cron: string, fnc: Function, options?: {
-        /**
-         * - 任务插件名称
-         */
-        name?: string;
-        /**
-         * - 任务优先级
-         */
-        priority?: number;
-        /**
-         * - 是否打印日志 传递布尔值
-         */
-        log?: boolean | Function;
-    }): PluginApps;
+    task(name: string, cron: string, fn: Function, options?: Omit<Options, 'priority'>): TaskInfo;
     /**
      * - 构建handler
      * @param key - 事件key
-     * @param fnc - 函数实现
+     * @param fn - 函数实现
      * @param options - 选项
      */
-    handler(key: string, fnc: (
+    handler(key: string, fn: (
     /**
      * - 自定义参数 由调用方传递
      */
-    args: any, 
+    args: {
+        [key: string]: any;
+    }, 
     /**
-     * - 拒绝处理器 调用后则不再继续执行下一个处理器
+     * - 停止循环函数 调用后则不再继续执行下一个处理器
      */
-    reject: (msg?: string) => void) => Promise<any>, options?: {
-        /**
-         * - 插件名称
-         */
-        name?: string;
-        /**
-         * - handler优先级
-         */
-        priority?: number;
-    }): PluginApps;
+    reject: (msg?: string) => void) => Promise<any>, options?: Omit<Options, 'log'>): HandlerInfo;
     /**
      * 构建contact
      * @param peer - 群号或者id
@@ -156,22 +153,12 @@ export declare class Karin {
     /**
      * accept
      * @param event - 监听事件
-     * @param fnc - 实现函数
+     * @param fn - 实现函数
      */
-    accept(event: NoticeListenEvent | RequestListenEvent, fnc: (e: KarinNoticeType | KarinRequestType) => boolean, options?: {
-        /**
-         * - 插件名称
-         */
-        name?: string;
-        /**
-         * - 优先级
-         */
-        priority?: number;
-        /**
-         * - 触发函数是否打印日志
-         */
-        log?: boolean;
-    }): PluginApps;
+    accept(event: AllNoticeSubType | AllRequestSubType, fn: (e: KarinNoticeType | KarinRequestType) => Promise<boolean>, options?: Options): AcceptInfo;
+    use(type: `${MiddlewareType.ReceiveMsg}`, fn: (e: KarinMessageType, next: Function) => Promise<void>, options: Omit<Options, 'log'>): UseInfo;
+    use(type: `${MiddlewareType.ReplyMsg}`, fn: (e: KarinMessageType, element: KarinElement[], next: Function) => Promise<void>, options: Omit<Options, 'log'>): UseInfo;
+    use(type: `${MiddlewareType.SendMsg}`, fn: (uid: string, contact: Contact, elements: KarinElement[]) => Promise<void>, options: Omit<Options, 'log'>): UseInfo;
     /**
      * - 启动
      */

package/lib/core/karin/karin.js

@@ -1,6 +1,5 @@
 import { server } from '../server/server.js';
 import { stateArr } from '../plugin/base.js';
-import PluginApp from '../plugin/app.js';
 import { common } from '../../utils/index.js';
 import { listener } from '../listener/listener.js';
 import onebot11 from '../../adapter/onebot/11/index.js';
@@ -20,7 +19,7 @@ export class Karin {
      */
     command(reg, second, options = {}) {
         reg = typeof reg === 'string' ? new RegExp(reg) : reg;
-        const fnc = typeof second === 'function'
+        const fn = typeof second === 'function'
             ? second
             : async (e) => {
                 const element = typeof second === 'number' ? String(second) : second;
@@ -33,72 +32,64 @@ export class Karin {
                 });
                 return !('stop' in options && !options.stop);
             };
-        const data = {
-            name: options.name || 'function',
-            priority: options.priority,
-            rule: [
-                {
-                    reg,
-                    fnc,
-                    permission: options.permission || 'all',
-                    log: options.log ?? true,
-                },
-            ],
+        const log = options.log === false
+            ? (id, text) => logger.bot('debug', id, text)
+            : (id, text) => logger.bot('info', id, text);
+        return {
+            data: '',
+            event: options.event || 'message',
+            fn,
+            fnname: 'fnc',
+            log,
+            name: options.name || 'command',
+            perm: options.permission || 'all',
+            rank: options.priority || 10000,
+            reg,
+            type: 'command',
         };
-        return PluginApp(data);
     }
     /**
      * - 构建定时任务
      * @param name - 任务名称
      * @param cron - cron表达式
-     * @param fnc - 执行函数
+     * @param fn - 执行函数
      * @param options - 选项
      */
-    task(name, cron, fnc, options) {
+    task(name, cron, fn, options) {
         if (!name)
             throw new Error('[task]: 缺少参数[name]');
         if (!cron)
             throw new Error('[task]: 缺少参数[cron]');
-        if (!fnc)
+        if (!fn)
             throw new Error('[task]: 缺少参数[fnc]');
-        const data = {
+        const log = options?.log === false ? (text) => logger.debug(text) : (text) => logger.info(text);
+        return {
+            cron,
+            fn,
+            log,
             name: options?.name || 'task',
-            priority: options?.priority,
-            task: [
-                {
-                    name,
-                    cron,
-                    fnc,
-                    log: options?.log ?? true,
-                },
-            ],
+            fnname: name,
+            type: 'task',
         };
-        return PluginApp(data);
     }
     /**
      * - 构建handler
      * @param key - 事件key
-     * @param fnc - 函数实现
+     * @param fn - 函数实现
      * @param options - 选项
      */
-    handler(key, fnc, options) {
+    handler(key, fn, options) {
         if (!key)
             throw new Error('[handler]: 缺少参数[key]');
-        if (!fnc)
+        if (!fn)
             throw new Error('[handler]: 缺少参数[fnc]');
-        const priority = options?.priority || 10000;
-        const data = {
+        return {
+            fn,
+            key,
             name: options?.name || 'handler',
-            priority,
-            handler: [
-                {
-                    key,
-                    fnc,
-                    priority,
-                },
-            ],
+            rank: options?.priority || 10000,
+            type: 'handler',
         };
-        return PluginApp(data);
     }
     /**
      * 构建contact
@@ -109,14 +100,14 @@ export class Karin {
     contact(peer, isGroup = true, sub_peer) {
         if (isGroup) {
             return {
-                scene: "group" /* Scene.Group */,
                 peer,
+                scene: "group" /* Scene.Group */,
                 sub_peer: sub_peer || '',
             };
         }
         return {
-            scene: "friend" /* Scene.Private */,
             peer,
+            scene: "friend" /* Scene.Private */,
             sub_peer: sub_peer || '',
         };
     }
@@ -129,9 +120,8 @@ export class Karin {
     render(data, multiPage) {
         if (typeof data === 'string') {
             /** 分片 */
-            if (typeof multiPage === 'number' || multiPage === true) {
+            if (typeof multiPage === 'number' || multiPage === true)
                 return render.renderMultiHtml(data, multiPage);
-            }
             /** 快速渲染 */
             return render.renderHtml(data);
         }
@@ -165,17 +155,34 @@ export class Karin {
     /**
      * accept
      * @param event - 监听事件
-     * @param fnc - 实现函数
+     * @param fn - 实现函数
      */
-    accept(event, fnc, options) {
-        const data = {
-            name: options?.name || 'accept',
-            priority: options?.priority,
+    accept(event, fn, options) {
+        const log = options?.log === false
+            ? (id, text) => logger.bot('debug', id, text)
+            : (id, text) => logger.bot('info', id, text);
+        return {
             event,
-            accept: fnc,
-            log: options?.log,
+            fn,
+            log,
+            name: options?.name || 'accept',
+            rank: options?.priority || 10000,
+            type: 'accept',
+        };
+    }
+    /**
+     * 中间件
+     * @param type 中间件类型
+     * @param fn 中间件函数
+     */
+    use(type, fn, options) {
+        return {
+            fn,
+            key: type,
+            name: options?.name || 'use',
+            rank: options?.priority || 10000,
+            type: 'use',
         };
-        return PluginApp(data);
     }
     /**
      * - 启动

package/lib/core/listener/listener.js

@@ -176,6 +176,20 @@ export class Listeners extends EventEmitter {
      * @param options.retry_count - 重试次数
      */
     async sendMsg(uid, contact, elements, options = { recallMsg: 0, retry_count: 1 }) {
+        /** 先调用中间件 */
+        for (const info of pluginLoader.use.sendMsg) {
+            try {
+                let next = false;
+                const nextFn = () => { next = true; };
+                await info.fn(uid, contact, elements, nextFn);
+                if (!next)
+                    break;
+            }
+            catch (e) {
+                logger.error('[消息中间件] 调用失败，已跳过');
+                logger.error(e);
+            }
+        }
         const bot = this.getBot(uid);
         if (!bot)
             throw new Error('发送消息失败: 未找到对应Bot实例');

package/lib/core/plugin/base.d.ts

@@ -7,17 +7,12 @@ export declare class Plugin implements PluginType {
      * @param name - 插件名称
      */
     name: PluginType['name'];
-    /**
-     * @param dsc - 插件描述
-     * @deprecated 请使用desc
-     */
-    dsc: PluginType['dsc'];
     /**
      * @param desc - 插件描述
      */
     desc: PluginType['desc'];
     /**
-     * @param event - 监听事件
+     * @param event - 监听事件 仅支持消息事件 其他事件请使用accept
      */
     event: PluginType['event'];
     /**
@@ -25,7 +20,8 @@ export declare class Plugin implements PluginType {
      */
     priority: PluginType['priority'];
     /**
-     * @param task - 定时任务
+     * @param task - 定时任务 即将废弃 请使用karin.task
+     * @deprecated
      */
     task: PluginType['task'];
     /**
@@ -33,11 +29,8 @@ export declare class Plugin implements PluginType {
      */
     rule: PluginType['rule'];
     /**
-     * @param button - 按钮
-     */
-    button: PluginType['button'];
-    /**
-     * @param handler - handler
+     * @param handler - handler 已废弃 请使用karin.handler
+     * @deprecated
      */
     handler: PluginType['handler'];
     /**
@@ -48,15 +41,11 @@ export declare class Plugin implements PluginType {
      * @param timeout - 上下文超时
      */
     timeout: PluginType['timeout'];
-    constructor({ name, dsc, desc, event, priority, task, rule, handler, button, }: {
+    constructor({ name, desc, event, priority, task, rule, handler, }: {
         /**
          * - 插件名称
          */
         name: string;
-        /**
-         * - 插件描述 没有则默认为名称
-         */
-        dsc: string;
         /**
          * - 插件描述 没有则默认为插件名称
          */
@@ -70,7 +59,8 @@ export declare class Plugin implements PluginType {
          */
         priority?: PluginType['priority'];
         /**
-         * - 定时任务
+         * - 定时任务 即将废弃 请使用karin.task
+         * @deprecated
          */
         task?: PluginType['task'];
         /**
@@ -78,13 +68,10 @@ export declare class Plugin implements PluginType {
          */
         rule?: PluginType['rule'];
         /**
-         * - handler
+         * - handler 已废弃 请使用karin.handler
+         * @deprecated
          */
         handler?: PluginType['handler'];
-        /**
-         * - 按钮
-         */
-        button?: PluginType['button'];
     });
     /**
      * - 快速回复

package/lib/core/plugin/base.js

@@ -6,17 +6,12 @@ export class Plugin {
      * @param name - 插件名称
      */
     name;
-    /**
-     * @param dsc - 插件描述
-     * @deprecated 请使用desc
-     */
-    dsc;
     /**
      * @param desc - 插件描述
      */
     desc;
     /**
-     * @param event - 监听事件
+     * @param event - 监听事件 仅支持消息事件 其他事件请使用accept
      */
     event;
     /**
@@ -24,7 +19,8 @@ export class Plugin {
      */
     priority;
     /**
-     * @param task - 定时任务
+     * @param task - 定时任务 即将废弃 请使用karin.task
+     * @deprecated
      */
     task;
     /**
@@ -32,11 +28,8 @@ export class Plugin {
      */
     rule;
     /**
-     * @param button - 按钮
-     */
-    button;
-    /**
-     * @param handler - handler
+     * @param handler - handler 已废弃 请使用karin.handler
+     * @deprecated
      */
     handler;
     /**
@@ -47,15 +40,13 @@ export class Plugin {
      * @param timeout - 上下文超时
      */
     timeout;
-    constructor({ name, dsc = name, desc = name, event = "message" /* EventType.Message */, priority = 10000, task = [], rule = [], handler = [], button = [], }) {
+    constructor({ name, desc = name, event = "message" /* EventType.Message */, priority = 10000, task = [], rule = [], handler = [], }) {
         this.name = name;
-        this.dsc = dsc;
         this.desc = desc;
         this.event = event;
         this.priority = priority;
         this.task = task;
         this.rule = rule;
-        this.button = button;
         this.handler = handler;
     }
     /**