node-karin 0.12.1 → 0.12.5

package/config/defSet/group.yaml

@@ -18,7 +18,7 @@ default:
   disable: []
 
 # 单个Bot默认配置
-Bot.self_id:
+Bot:self_id:
   # 群聊中所有消息冷却时间，单位秒,0则无限制
   GroupCD: 0
   # 群聊中 每个人的消息冷却时间，单位秒，0则无限制。注意，开启后所有消息都会进CD，无论是否触发插件。
@@ -37,7 +37,7 @@ Bot.self_id:
   disable: []
 
 # 单个Bot单个群配置
-Bot.self_id.group_id:
+Bot:self_id:group_id:
   # 群聊中所有消息冷却时间，单位秒,0则无限制
   GroupCD: 0
   # 群聊中 每个人的消息冷却时间，单位秒，0则无限制。注意，开启后所有消息都会进CD，无论是否触发插件。

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

@@ -154,6 +154,9 @@ export function KarinConvertAdapter(data, bot) {
                 elements.push({ type: 'weather', data: { city: i.city, type: i.type } });
                 break;
             }
+            case 'raw':
+                elements.push(i.data);
+                break;
             case 'button':
             case 'markdown':
             case 'keyboard':

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

@@ -90,11 +90,12 @@ export class OB11Event {
         const time = data.time;
         const self_id = data.self_id + '';
         let notice = {};
-        const user_id = data.user_id + '';
+        /** 别问为啥any... 我是any糕手~ */
+        const user_id = (data.user_id || data.operator_id) + '';
         const event_id = `notice.${time}`;
         const sender = {
-            uid: data.user_id + '',
-            uin: data.user_id + '',
+            uid: user_id,
+            uin: user_id,
             nick: '',
             role: "unknown" /* Role.Unknown */,
         };
@@ -351,6 +352,30 @@ export class OB11Event {
                 notice = new KarinNotice(options);
                 break;
             }
+            // Language表情动态上报
+            case 'reaction': {
+                const group_id = data.group_id + '';
+                const content = {
+                    group_id,
+                    message_id: data.message_id,
+                    face_id: Number(data.code),
+                    is_set: data.sub_type === 'add',
+                };
+                const options = {
+                    raw_event: data,
+                    time,
+                    self_id,
+                    user_id,
+                    event_id,
+                    sender,
+                    contact,
+                    content,
+                    group_id,
+                    sub_event: "group_message_reaction" /* NoticeSubType.GroupMessageReaction */,
+                };
+                notice = new KarinNotice(options);
+                break;
+            }
             default: {
                 return this.adapter.logger('error', '未知通知事件：', JSON.stringify(data));
             }

package/lib/api/git.d.ts

@@ -0,0 +1,6 @@
+import { dirName } from '../types/index.js';
+/**
+ * 获取git插件列表
+ * @param isPack - 是否屏蔽不带package.json的插件，默认为false
+ */
+export declare function getGitPlugins(isPack?: boolean): Array<dirName>;

package/lib/api/git.js

@@ -0,0 +1,16 @@
+import fs from 'fs';
+/**
+ * 获取git插件列表
+ * @param isPack - 是否屏蔽不带package.json的插件，默认为false
+ */
+export function getGitPlugins(isPack = false) {
+    const dir = './plugins';
+    let list = fs.readdirSync(dir, { withFileTypes: true });
+    /** 忽略非文件夹、非 karin-plugin-开头的文件夹 */
+    list = list.filter(v => v.isDirectory() && v.name.startsWith('karin-plugin-'));
+    if (isPack)
+        list = list.filter(v => fs.existsSync(`${dir}/${v.name}/package.json`));
+    const arr = [];
+    list.map(v => arr.push(v.name));
+    return arr;
+}

package/lib/api/npm.d.ts

@@ -0,0 +1,7 @@
+import { NpmInfo } from '../utils/index.js';
+/**
+ * 获取npm插件列表
+ * @param showDetails - 是否返回详细信息
+ * 默认只返回插件npm包名，为true时返回详细的{dir, name}[]
+ */
+export declare function getNpmPlugins<T extends boolean>(showDetails: T): Promise<T extends true ? NpmInfo[] : string[]>;

package/lib/api/npm.js

@@ -0,0 +1,63 @@
+import fs from 'fs';
+import path from 'path';
+import { readJson } from './readJson.js';
+/**
+ * 获取npm插件列表
+ * @param showDetails - 是否返回详细信息
+ * 默认只返回插件npm包名，为true时返回详细的{dir, name}[]
+ */
+export async function getNpmPlugins(showDetails) {
+    /** 屏蔽的依赖包列表 */
+    const exclude = ['art-template', 'axios', 'chalk', 'chokidar', 'commander', 'express', 'level', 'lodash', 'log4js', 'moment', 'node-karin', 'node-schedule', 'redis', 'ws', 'yaml'];
+    const pkg = readJson('./package.json');
+    const dependencies = Object.keys(pkg.dependencies).filter((name) => !exclude.includes(name));
+    if (!showDetails) {
+        const list = [];
+        const readPackageJson = async (name) => {
+            try {
+                const pkgPath = path.join(process.cwd(), 'node_modules', name, 'package.json');
+                const pkg = readJson(pkgPath);
+                if (pkg?.karin)
+                    list.push(name);
+            }
+            catch (error) {
+                logger.error(`[common] 解析 package.json 时出错：${error.stack || error.message || JSON.stringify(error)}`);
+            }
+        };
+        await Promise.all(dependencies.map(readPackageJson));
+        return list;
+    }
+    const list = [];
+    /** 获取详细的npm信息 */
+    const readPackageJson = async (files) => {
+        try {
+            const root = path.join(process.cwd(), 'node_modules', files);
+            const pkgPath = path.join(root, 'package.json');
+            const pkg = readJson(pkgPath);
+            if (!pkg?.karin)
+                return;
+            if (pkg?.main) {
+                list.push({ plugin: files, path: path.dirname(pkg.main), file: path.basename(pkg.main), isMain: true });
+            }
+            if (pkg?.karin?.apps?.length) {
+                pkg.karin.apps.forEach((app) => {
+                    if (!fs.existsSync(path.join(root, app))) {
+                        logger.error(`[common] npm插件${files}的app目录${app}不存在 已跳过`);
+                        return;
+                    }
+                    fs.readdirSync(path.join(root, app)).forEach((filename) => {
+                        /** 忽略非js文件 npm包不考虑ts */
+                        if (!filename.endsWith('.js'))
+                            return;
+                        list.push({ plugin: files, path: app, file: filename, isMain: false });
+                    });
+                });
+            }
+        }
+        catch (error) {
+            logger.error(`[common] 获取npm插件列表时出错：${error.stack || error.message || JSON.stringify(error)}`);
+        }
+    };
+    await Promise.all(dependencies.map(readPackageJson));
+    return list;
+}

package/lib/api/readJson.d.ts

@@ -0,0 +1,5 @@
+/**
+ * - 解析json文件
+ * @param file - 文件路径
+ */
+export declare function readJson(file: string): any;

package/lib/api/readJson.js

@@ -0,0 +1,8 @@
+import fs from 'fs';
+/**
+ * - 解析json文件
+ * @param file - 文件路径
+ */
+export function readJson(file) {
+    return JSON.parse(fs.readFileSync(file, 'utf8'));
+}

package/lib/cli/index.d.ts

@@ -73,10 +73,6 @@ export declare class KarinCli {
      * @param pkg - 包管理器
      */
     getRemoteVersion(name: string, pkg: 'pnpm' | 'cnpm' | 'yarn' | 'npm'): Promise<string>;
-    /**
-     * 获取git插件列表
-     */
-    getGitPlugins(): Array<string>;
     /**
      * 封装exec
      * @param cmd - 命令

package/lib/cli/index.js

@@ -5,6 +5,8 @@ import axios from 'axios';
 import { fileURLToPath } from 'url';
 import { getRegistry } from './pkg.js';
 import { exec as execCmd, spawn } from 'child_process';
+import { getNpmPlugins } from '../api/npm.js';
+import { getGitPlugins } from '../api/git.js';
 export class KarinCli {
     child;
     filename;
@@ -123,7 +125,7 @@ export class KarinCli {
         const data = this.getConfigData('pm2');
         /** 修正入口文件路径 兼容0.6.28以前的版本 */
         if (!fs.existsSync('./src') && filePath === './config/config/pm2.yaml') {
-            const script = './node_modules/node-karin/lib/index.js';
+            const script = './node_modules/node-karin/lib/cli/start.js';
             if (data.apps[0].script !== script) {
                 data.apps[0].script = script;
                 fs.writeFileSync(filePath, yaml.stringify(data));
@@ -169,24 +171,8 @@ export class KarinCli {
      * 更新依赖
      */
     async update() {
-        /** 屏蔽的依赖包列表 */
-        const pkgdependencies = [
-            'art-template',
-            'axios',
-            'chalk',
-            'chokidar',
-            'commander',
-            'express',
-            'level',
-            'lodash',
-            'log4js',
-            'moment',
-            'node-schedule',
-            'redis',
-            'ws',
-            'yaml',
-        ];
-        const list = Object.keys(this.pkg(false).dependencies).filter(key => !pkgdependencies.includes(key));
+        const list = await getNpmPlugins(false);
+        list.push('node-karin');
         /** 获取包管理器 */
         const pkg = getRegistry();
         const cmd = pkg === 'yarn' ? 'yarn upgrade' : `${pkg} update`;
@@ -210,11 +196,14 @@ export class KarinCli {
         }));
         console.log('[依赖更新] 所有npm依赖已更新完成~');
         console.log('[依赖更新] 开始更新git插件...');
-        const gitList = this.getGitPlugins();
+        const gitList = getGitPlugins();
         if (!gitList.length)
             return console.log('[依赖更新] 没有git插件需要更新~');
         await Promise.all(gitList.map(async (item) => {
             const dir = path.resolve(process.cwd(), 'plugins', item);
+            /** 检查是否是git仓库 */
+            if (!fs.existsSync(path.join(dir, '.git')))
+                return;
             try {
                 await this.exec('git pull', { cwd: dir });
                 console.log(`[依赖更新] ${item} 更新完成~`);
@@ -261,19 +250,6 @@ export class KarinCli {
         }
         return text.trim();
     }
-    /**
-     * 获取git插件列表
-     */
-    getGitPlugins() {
-        const dir = path.resolve(process.cwd(), 'plugins');
-        let list = fs.readdirSync(dir, { withFileTypes: true });
-        /** 忽略非文件夹、非 karin-plugin-开头的文件夹 */
-        list = list.filter(v => v.isDirectory() && v.name.startsWith('karin-plugin-'));
-        list = list.filter(v => fs.existsSync(`${dir}/${v.name}/package.json`));
-        const arr = [];
-        list.map(v => arr.push(v.name));
-        return arr;
-    }
     /**
      * 封装exec
      * @param cmd - 命令

package/lib/cli/start.js

@@ -1,5 +1,8 @@
 import { program } from 'commander';
 import { KarinCli } from './index.js';
+/** 兼容node .启动方式 */
+if (process.argv.length === 2)
+    process.argv.push('.');
 const karin = new KarinCli();
 program.version(karin.pkg(true).version, '-v, --version', '显示版本号');
 program.command('.').description('启动karin').action(() => karin.start("prod" /* Mode.Prod */, "js" /* Lang.Js */, "node" /* Runner.Node */));

package/lib/core/init/dir.d.ts

@@ -1,4 +1,4 @@
-/**
- * - 获取当前npm包的根目录
- */
+/** 获取当前npm包的根目录 */
 export declare const karinDir: string;
+/** 当前是否处于npm包环境 否则代表处于开发环境 */
+export declare const isPkg: boolean;

package/lib/core/init/dir.js

@@ -1,7 +1,7 @@
 import path from 'path';
 import { fileURLToPath } from 'url';
 const filename = fileURLToPath(import.meta.url);
-/**
- * - 获取当前npm包的根目录
- */
-export const karinDir = path.resolve(filename, '../../../../').replace(/\\/g, '/').replace(/\/$/, '');
+/** 获取当前npm包的根目录 */
+export const karinDir = path.resolve(filename, '../../../..').replace(/\/$/, '');
+/** 当前是否处于npm包环境 否则代表处于开发环境 */
+export const isPkg = karinDir.includes('node_modules');

package/lib/core/init/init.js

@@ -1,4 +1,4 @@
-import { logger } from '../../utils/index.js';
+import { logger } from '../../utils/core/logger.js';
 /**
  * 启动日志
  */

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

@@ -71,6 +71,8 @@ export interface OptionsElement extends OptionsCommand {
 }
 export declare class Karin extends Listeners {
     #private;
+    /** 存储器 由开发者自行调用 */
+    store: Map<any, any>;
     constructor();
     /**
     * @param reg - 正则表达式

package/lib/core/karin/karin.js

@@ -9,9 +9,12 @@ import { Listeners } from '../listener/listener.js';
 export class Karin extends Listeners {
     /** 是否启动 */
     #start;
+    /** 存储器 由开发者自行调用 */
+    store;
     constructor() {
         super();
         this.#start = false;
+        this.store = new Map();
         this.run();
     }
     /**

package/lib/core/listener/listener.js

@@ -49,6 +49,32 @@ export class Listeners extends EventEmitter {
         this.list.push({ index, type: data.type, bot: data.bot });
         logger.info(`[机器人][注册][${data.type}] ` + logger.green(`[account:${data.bot.account.uid || data.bot.account.uin}(${data.bot.account.name})]`));
         this.#online(data.bot.account.uid || data.bot.account.uin);
+        /** 对sendForwardMessage方法进行修改 添加中间键 */
+        const sendForwardMessage = data.bot.sendForwardMessage;
+        data.bot.sendForwardMessage = async (contact, elements) => {
+            for (const info of pluginLoader.use.forwardMsg) {
+                try {
+                    let next = false;
+                    let exit = false;
+                    const nextFn = () => { next = true; };
+                    const exitFn = () => { exit = true; };
+                    await info.fn(contact, elements, nextFn, exitFn);
+                    if (exit) {
+                        const plugin = pluginLoader.plugin.get(info.key);
+                        logger.debug(`[消息中间件][${plugin.plugin}][${plugin.file}] 主动操作退出`);
+                        return { message_id: '' };
+                    }
+                    if (!next)
+                        break;
+                }
+                catch (e) {
+                    logger.error('[消息中间件] 调用失败，已跳过');
+                    logger.error(e);
+                }
+            }
+            const result = await sendForwardMessage(contact, elements);
+            return result;
+        };
         logger.debug('注册', this.list);
         return index;
     }

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

@@ -110,11 +110,15 @@ export declare class Plugin implements PluginType {
         message_id: string;
     }>;
     /**
+     * - 已废弃 请使用karin.ctx
      * - 构建上下文键
+     * @deprecated
      */
     conKey(): string;
     /**
-     * 设置上下文状态
+     * - 已废弃 请使用karin.ctx
+     * - 设置上下文状态
+     * @deprecated
      */
     setContext(
     /**
@@ -130,11 +134,14 @@ export declare class Plugin implements PluginType {
      */
     time?: number): void;
     /**
-     * 获取上下文状态
+     * - 已废弃 请使用karin.ctx
+     * - 获取上下文状态
      */
     getContext(): stateArrType[string];
     /**
-     * 清除上下文状态
+     * - 已废弃 请使用karin.ctx
+     * - 清除上下文状态
+     * @deprecated
      */
     finish(): void;
     e: EType<this>;

package/lib/core/plugin/base.js

@@ -63,13 +63,17 @@ export class Plugin {
         return result;
     }
     /**
+     * - 已废弃 请使用karin.ctx
      * - 构建上下文键
+     * @deprecated
      */
     conKey() {
         return `${this.e.isGroup ? `${this.e.group_id}.` : ''}` + (this.userId || this.e.user_id);
     }
     /**
-     * 设置上下文状态
+     * - 已废弃 请使用karin.ctx
+     * - 设置上下文状态
+     * @deprecated
      */
     setContext(
     /**
@@ -101,14 +105,17 @@ export class Plugin {
         }, time * 1000);
     }
     /**
-     * 获取上下文状态
+     * - 已废弃 请使用karin.ctx
+     * - 获取上下文状态
      */
     getContext() {
         const key = this.conKey();
         return stateArr[key];
     }
     /**
-     * 清除上下文状态
+     * - 已废弃 请使用karin.ctx
+     * - 清除上下文状态
+     * @deprecated
      */
     finish() {
         const key = this.conKey();

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

@@ -119,6 +119,10 @@ declare class PluginLoader {
     /**
      * 缓存插件
      * @param index - 插件索引
+     * @param plugin - 插件名称
+     * @param file - 插件文件
+     * @param info - 插件信息
+     * @param App - 插件类
      */
     cachePlugin(index: number, plugin: string, file: string, info: AppType, App?: any): Promise<boolean>;
     /**
@@ -127,10 +131,16 @@ declare class PluginLoader {
     printDependErr(): void;
     /**
      * 卸载插件
+     * @param plugin - 插件名称
+     * @param _path - 插件apps相对路径
+     * @param file - 插件文件名称
      */
     uninstallApp(plugin: string, _path: string, file: string): void;
     /**
      * 监听文件夹更新
+     * @param plugin - 插件名称
+     * @param _path - 插件apps相对路径
+     * @returns 是否成功
      */
     watchDir(plugin: string, _path: string): Promise<boolean>;
 }

package/lib/core/plugin/loader.js

@@ -55,6 +55,8 @@ class PluginLoader {
             recvMsg: [],
             replyMsg: [],
             sendMsg: [],
+            forwardMsg: [],
+            notFound: [],
         };
         this.ext = process.env.karin_app_lang === 'ts' ? ['.js', '.ts'] : ['.js'];
         this.index = 0;
@@ -289,6 +291,8 @@ class PluginLoader {
         this.use.recvMsg = lodash.orderBy(this.use.recvMsg, ['rank'], ['asc']);
         this.use.replyMsg = lodash.orderBy(this.use.replyMsg, ['rank'], ['asc']);
         this.use.sendMsg = lodash.orderBy(this.use.sendMsg, ['rank'], ['asc']);
+        this.use.forwardMsg = lodash.orderBy(this.use.forwardMsg, ['rank'], ['asc']);
+        this.use.notFound = lodash.orderBy(this.use.notFound, ['rank'], ['asc']);
         const handler = Object.keys(this.handler);
         handler.forEach(key => {
             this.handler[key] = lodash.orderBy(this.handler[key], ['rank'], ['asc']);
@@ -414,6 +418,10 @@ class PluginLoader {
     /**
      * 缓存插件
      * @param index - 插件索引
+     * @param plugin - 插件名称
+     * @param file - 插件文件
+     * @param info - 插件信息
+     * @param App - 插件类
      */
     async cachePlugin(index, plugin, file, info, App) {
         if (!info?.name) {
@@ -532,6 +540,9 @@ class PluginLoader {
     }
     /**
      * 卸载插件
+     * @param plugin - 插件名称
+     * @param _path - 插件apps相对路径
+     * @param file - 插件文件名称
      */
     uninstallApp(plugin, _path, file) {
         this.plugin.forEach((info, key) => {
@@ -544,6 +555,8 @@ class PluginLoader {
                 this.use.recvMsg = this.use.recvMsg.filter(val => val.key !== key);
                 this.use.replyMsg = this.use.replyMsg.filter(val => val.key !== key);
                 this.use.sendMsg = this.use.sendMsg.filter(val => val.key !== key);
+                this.use.forwardMsg = this.use.forwardMsg.filter(val => val.key !== key);
+                this.use.notFound = this.use.notFound.filter(val => val.key !== key);
                 /** 定时任务需要先停止 */
                 this.task = this.task.filter(val => {
                     if (val.key === key) {
@@ -570,6 +583,9 @@ class PluginLoader {
     }
     /**
      * 监听文件夹更新
+     * @param plugin - 插件名称
+     * @param _path - 插件apps相对路径
+     * @returns 是否成功
      */
     async watchDir(plugin, _path) {
         const root = path.join(this.dir, plugin, _path);

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

@@ -5,11 +5,22 @@ import { KarinMessageType } from '../../types/index.js';
  */
 export declare class MessageHandler extends EventBaseHandler {
     e: KarinMessageType;
+    /** 当前事件是否是上下文事件 */
+    isContext: boolean;
     constructor(e: KarinMessageType);
+    start(): Promise<void>;
     /**
      * 先对消息事件进行初始化
      */
     init(): void;
+    /**
+     * 开始中间件
+     */
+    startUse(): Promise<void>;
+    /**
+     * 结束中间件
+     */
+    endUse(): Promise<void>;
     /**
      * 响应模式检查 返回false表示未通过
      */
@@ -18,6 +29,19 @@ export declare class MessageHandler extends EventBaseHandler {
      * 处理消息
      */
     deal(): Promise<void>;
+    /**
+     * 获取下文
+     */
+    getContext(): {
+        type: "fnc";
+        fnc: Function;
+    } | {
+        type: "class";
+        fnc: import("../../core/index.js").Plugin;
+        name: string;
+    } | {
+        type: "ctx";
+    };
     /**
      * 处理上下文
      */