node-karin 0.10.6 → 0.11.0

package/lib/utils/common/common.d.ts

@@ -1,7 +1,13 @@
 import fs from 'fs';
 import { AxiosRequestConfig } from 'axios';
 import { Readable } from 'stream';
-import { ButtonElement, ButtonType, dirName, fileName, KarinElement, NodeElement, KeyBoardElement } from '../../types/index.js';
+import { ButtonElement, ButtonType, dirName, KarinElement, NodeElement, KeyBoardElement } from '../../types/index.js';
+export interface NpmInfo {
+    plugin: string;
+    path: string;
+    file: string;
+    isMain: boolean;
+}
 /**
  * 常用方法
  */
@@ -52,6 +58,11 @@ declare class Common {
      * @returns 返回true为插件包
      */
     isPlugin(path: string): boolean;
+    /**
+     * 去掉相对路径的前缀和后缀
+     * @param root - 相对路径路径
+     */
+    getRelPath(root: string): string;
     /**
      * 判断路径是否存在
      * @param path - 路径
@@ -142,16 +153,17 @@ declare class Common {
      * @param isPack - 是否屏蔽不带package.json的插件，默认为false
      */
     getPlugins(isPack?: boolean): Array<dirName>;
+    /**
+     * 获取git插件列表
+     * @param isPack - 是否屏蔽不带package.json的插件，默认为false
+     */
+    getGitPlugins(isPack?: boolean): Array<dirName>;
     /**
      * 获取npm插件列表
-     * @param showDetails - 是否返回详细信息，默认为false
+     * @param showDetails - 是否返回详细信息
      * 默认只返回插件npm包名，为true时返回详细的{dir, name}[]
      */
-    getNpmPlugins<T extends boolean>(showDetails: T): Promise<T extends true ? {
-        dir: string;
-        name: fileName;
-        isMain: boolean;
-    }[] : string[]>;
+    getNpmPlugins<T extends boolean>(showDetails: T): Promise<T extends true ? NpmInfo[] : string[]>;
     /**
      * 获取运行时间
      */

package/lib/utils/common/common.js

@@ -120,6 +120,13 @@ class Common {
     isPlugin(path) {
         return this.exists(`${path}/package.json`);
     }
+    /**
+     * 去掉相对路径的前缀和后缀
+     * @param root - 相对路径路径
+     */
+    getRelPath(root) {
+        return root.replace(/\\+/g, '/').replace(/\.+\/+|\/+$/g, '');
+    }
     /**
      * 判断路径是否存在
      * @param path - 路径
@@ -269,7 +276,7 @@ class Common {
         /** file:// */
         const files = file.replace(/^file:\/\//, '');
         if (fs.existsSync(files))
-            return fs.readFileSync(file).toString('base64');
+            return fs.readFileSync(files).toString('base64');
         /** 无前缀base64:// */
         return Buffer.from(file, 'base64').toString('base64');
     }
@@ -359,78 +366,72 @@ class Common {
         list.map(v => arr.push(v.name));
         return arr;
     }
+    /**
+     * 获取git插件列表
+     * @param isPack - 是否屏蔽不带package.json的插件，默认为false
+     */
+    getGitPlugins(isPack = false) {
+        return this.getPlugins(isPack);
+    }
     /**
      * 获取npm插件列表
-     * @param showDetails - 是否返回详细信息，默认为false
+     * @param showDetails - 是否返回详细信息
      * 默认只返回插件npm包名，为true时返回详细的{dir, name}[]
      */
     async getNpmPlugins(showDetails) {
         /** 屏蔽的依赖包列表 */
-        const pkgdependencies = [
-            '@grpc/grpc-js',
-            '@grpc/proto-loader',
-            'art-template',
-            'axios',
-            'chalk',
-            'chokidar',
-            'express',
-            'kritor-proto',
-            'level',
-            'lodash',
-            'log4js',
-            'moment',
-            'node-karin',
-            'node-schedule',
-            'redis',
-            'ws',
-            'yaml',
-        ];
-        const pkg = JSON.parse(fs.readFileSync('./package.json', 'utf8'));
-        const dependencies = Object.keys(pkg.dependencies).filter((name) => !pkgdependencies.includes(name));
+        const exclude = ['art-template', 'axios', 'chalk', 'chokidar', 'express', 'level', 'lodash', 'log4js', 'moment', 'node-karin', 'node-schedule', 'redis', 'ws', 'yaml'];
+        const pkg = this.readJson('./package.json');
+        const dependencies = Object.keys(pkg.dependencies).filter((name) => !exclude.includes(name));
         if (!showDetails) {
             const list = [];
-            // 检查pkg是否存在karin字段
             const readPackageJson = async (name) => {
                 try {
                     const pkgPath = path.join(process.cwd(), 'node_modules', name, 'package.json');
-                    const pkg = JSON.parse(fs.readFileSync(pkgPath, 'utf8'));
+                    const pkg = this.readJson(pkgPath);
                     if (pkg?.karin)
                         list.push(name);
                 }
-                catch { }
+                catch (error) {
+                    logger.error(`[common] 解析 package.json 时出错：${error.stack || error.message || JSON.stringify(error)}`);
+                }
             };
             await Promise.all(dependencies.map(readPackageJson));
             return list;
         }
-        else {
-            const list = [];
-            const readPackageJson = async (files) => {
-                try {
-                    const pkgPath = path.join(process.cwd(), 'node_modules', files, 'package.json');
-                    const pkg = JSON.parse(fs.readFileSync(pkgPath, 'utf8'));
-                    if (pkg?.karin) {
-                        if (pkg?.main) {
-                            const dir = `${files}/${path.dirname(pkg.main).replace(/\.\//, '')}`;
-                            list.push({ dir, name: path.basename(pkg.main), isMain: true });
-                        }
-                        if (pkg?.karin?.apps?.length) {
-                            pkg.karin.apps.forEach((app) => {
-                                fs.readdirSync(`./node_modules/${files}/${app}`).forEach((filename) => {
-                                    /** 忽略非js */
-                                    if (!filename.endsWith('.js'))
-                                        return;
-                                    const dir = `${files}/${app}`;
-                                    list.push({ dir, name: filename, isMain: false });
-                                });
-                            });
+        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 = this.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 { }
-            };
-            await Promise.all(dependencies.map(readPackageJson));
-            return list;
-        }
+            }
+            catch (error) {
+                logger.error(`[common] 获取npm插件列表时出错：${error.stack || error.message || JSON.stringify(error)}`);
+            }
+        };
+        await Promise.all(dependencies.map(readPackageJson));
+        return list;
     }
     /**
      * 获取运行时间
@@ -456,7 +457,7 @@ class Common {
                     logs.push(val.text);
                     break;
                 case 'face':
-                    logs.push(`[face:${val.id}]`);
+                    logs.push(`[face: ${val.id}]`);
                     break;
                 case 'video':
                 case 'image':
@@ -472,47 +473,47 @@ class Common {
                     else {
                         file = 'base64://...';
                     }
-                    logs.push(`[${val.type}:${file}]`);
+                    logs.push(`[${val.type}: ${file}]`);
                     break;
                 }
                 case 'at':
-                    logs.push(`[at:${val.uid}]`);
+                    logs.push(`[at: ${val.uid}]`);
                     break;
                 case 'rps':
-                    logs.push(`[rps:${val.id}]`);
+                    logs.push(`[rps: ${val.id}]`);
                     break;
                 case 'dice':
-                    logs.push(`[dice:${val.id}]`);
+                    logs.push(`[dice: ${val.id}]`);
                     break;
                 case 'poke':
-                    logs.push(`[poke:${val.id}]`);
+                    logs.push(`[poke: ${val.id}]`);
                     break;
                 case 'share':
-                    logs.push(`[share:${JSON.stringify(val)}]`);
+                    logs.push(`[share: ${JSON.stringify(val)}]`);
                     break;
                 case 'contact':
-                    logs.push(`[contact:${JSON.stringify(val)}]`);
+                    logs.push(`[contact: ${JSON.stringify(val)}]`);
                     break;
                 case 'location':
-                    logs.push(`[location:${JSON.stringify(val)}]`);
+                    logs.push(`[location: ${JSON.stringify(val)}]`);
                     break;
                 case 'music':
-                    logs.push(`[music:${JSON.stringify(val)}]`);
+                    logs.push(`[music: ${JSON.stringify(val)}]`);
                     break;
                 case 'reply':
-                    logs.push(`[reply:${val.message_id}]`);
+                    logs.push(`[reply: ${val.message_id}]`);
                     break;
                 case 'forward':
-                    logs.push(`[forward:${val.res_id}]`);
+                    logs.push(`[forward: ${val.res_id}]`);
                     break;
                 case 'xml':
-                    logs.push(`[xml:${val.data}]`);
+                    logs.push(`[xml: ${val.data}]`);
                     break;
                 case 'json':
-                    logs.push(`[json:${val.data}]`);
+                    logs.push(`[json: ${val.data}]`);
                     break;
                 case 'markdown': {
-                    logs.push(`[markdown:${val.content}]`);
+                    logs.push(`[markdown: ${val.content}]`);
                     break;
                 }
                 case 'markdown_tpl': {
@@ -522,21 +523,21 @@ class Common {
                     const content = { id: val.custom_template_id };
                     for (const v of params)
                         content[v.key] = v.values[0];
-                    logs.push(`[markdown_tpl:${JSON.stringify(content)}]`);
+                    logs.push(`[markdown_tpl: ${JSON.stringify(content)}]`);
                     break;
                 }
                 case 'keyboard': {
-                    logs.push(`[rows:${JSON.stringify(val.rows)}]`);
+                    logs.push(`[rows: ${JSON.stringify(val.rows)}]`);
                     break;
                 }
                 case 'button':
-                    logs.push(`[button:${JSON.stringify(val.data)}]`);
+                    logs.push(`[button: ${JSON.stringify(val.data)}]`);
                     break;
                 case 'long_msg':
-                    logs.push(`[long_msg:${val.id}]`);
+                    logs.push(`[long_msg: ${val.id}]`);
                     break;
                 default:
-                    logs.push(`[未知:${JSON.stringify(val)}]`);
+                    logs.push(`[未知: ${JSON.stringify(val)}]`);
             }
         }
         return logs.join('');

package/lib/utils/config/config.d.ts

@@ -95,7 +95,7 @@ export declare const config: {
     changeApp(): Promise<void>;
     changeCfg(): Promise<void>;
     changeGroup(): Promise<void>;
-    "__#2@#review"(): Promise<void>;
+    "__#15@#review"(): Promise<void>;
 };
 export declare const Cfg: {
     /**
@@ -189,5 +189,5 @@ export declare const Cfg: {
     changeApp(): Promise<void>;
     changeCfg(): Promise<void>;
     changeGroup(): Promise<void>;
-    "__#2@#review"(): Promise<void>;
+    "__#15@#review"(): Promise<void>;
 };

package/lib/utils/core/handler.d.ts

@@ -1,21 +1,7 @@
-import { PluginType, PluginApps } from '../../types/index.js';
 /**
  * 事件处理器类
  */
 export declare const handler: {
-    /**
-     * 添加事件处理器
-     * @param index 插件索引
-     * @param Class 插件类
-     */
-    add(index: string, Class: PluginType | PluginApps): Promise<void>;
-    /**
-     * 删除事件处理器
-     * 如果不传参数则删除所有处理器
-     * @param index 插件索引
-     * @param key 事件键
-     */
-    del(index?: string, key?: string): boolean;
     /**
      * 调用事件处理器
      * @param key 事件键

package/lib/utils/core/handler.js

@@ -1,70 +1,9 @@
-import lodash from 'lodash';
 import logger from './logger.js';
 import { pluginLoader as loader } from '../../core/index.js';
 /**
  * 事件处理器类
  */
 export const handler = new (class EventHandler {
-    /**
-     * 添加事件处理器
-     * @param index 插件索引
-     * @param Class 插件类
-     */
-    async add(index, Class) {
-        lodash.forEach(Class.handler, val => {
-            if (!val.key)
-                logger.error(`[Handler][Add]: [${Class.name}] 缺少 key`);
-            if (!val.fnc)
-                logger.error(`[Handler][Add]: [${Class.name}] 缺少 fnc`);
-            logger.debug(`[Handler][Reg]: [${Class.name}][${val.key}]`);
-            if (!Array.isArray(loader.handlerIds[val.key]))
-                loader.handlerIds[val.key] = [];
-            loader.handlerIds[val.key].push({ index, fnc: val.fnc, priority: val.priority || Class.priority });
-            loader.handlerIds[val.key] = lodash.orderBy(loader.handlerIds[val.key], ['priority'], ['asc']);
-        });
-    }
-    /**
-     * 删除事件处理器
-     * 如果不传参数则删除所有处理器
-     * @param index 插件索引
-     * @param key 事件键
-     */
-    del(index = '', key = '') {
-        /** 无参 */
-        if (!key && !index) {
-            loader.handlerIds = {};
-            return true;
-        }
-        /** 删除指定索引插件 */
-        if (!key) {
-            for (const v of Object.keys(loader.handlerIds)) {
-                loader.handlerIds[v] = loader.handlerIds[v].filter(v => v.index !== index);
-                // 如果处理器为空则删除键
-                if (!loader.handlerIds[v].length) {
-                    delete loader.handlerIds[v];
-                }
-                else {
-                    loader.handlerIds[v] = lodash.orderBy(loader.handlerIds[v], ['priority'], ['asc']);
-                }
-            }
-            return true;
-        }
-        /** 删除指定key */
-        if (!index) {
-            loader.handlerIds[key] && delete loader.handlerIds[key];
-            return true;
-        }
-        /** 删除指定key的index */
-        if (!loader.handlerIds[key])
-            return false;
-        loader.handlerIds[key] = loader.handlerIds[key].filter(v => v.index !== index);
-        if (!loader.handlerIds[key].length) {
-            delete loader.handlerIds[key];
-            return true;
-        }
-        loader.handlerIds[key] = lodash.orderBy(loader.handlerIds[key], ['priority'], ['asc']);
-        return true;
-    }
     /**
      * 调用事件处理器
      * @param key 事件键
@@ -72,8 +11,8 @@ export const handler = new (class EventHandler {
      */
     async call(key, args) {
         let res;
-        for (const v of loader.handlerIds[key] || []) {
-            const info = loader.PluginList[v.index];
+        for (const info of loader.handler[key] || []) {
+            const plugin = loader.plugin[info.key];
             try {
                 let done = true;
                 /**
@@ -82,26 +21,18 @@ export const handler = new (class EventHandler {
                  */
                 const reject = (msg = '') => {
                     if (msg)
-                        logger.mark(`[Handler][Reject]: [${info.file.dir}][${info.file.name}][${key}] ${msg}`);
+                        logger.mark(`[Handler][Reject]: [${plugin.plugin}][${info.name}][${key}] ${msg}`);
                     done = false;
                 };
-                if (info.file.type === 'function' && typeof v.fnc === 'function') {
-                    res = await v.fnc(args, reject);
-                }
-                else {
-                    const cla = new info.file.Fnc();
-                    if (args.e)
-                        cla.e = args.e;
-                    res = await cla[v.fnc](args, reject);
-                }
+                res = await info.fn(args, reject);
                 if (done) {
-                    logger.mark(`[Handler][Done]: [${info.file.dir}][${info.file.name}][${key}]`);
+                    logger.mark(`[Handler][Done]: [${plugin.plugin}][${info.name}][${key}]`);
                     return res;
                 }
             }
             catch (e) {
                 // 产生错误继续下一个处理器
-                logger.error(`[Handler][Error]: [${info.file.dir}][${info.file.name}][${key}] ${e}`);
+                logger.error(`[Handler][Error]: [${plugin.plugin}][${info.name}][${key}] ${e}`);
             }
         }
         return res;
@@ -110,6 +41,6 @@ export const handler = new (class EventHandler {
      * 检查是否存在指定键的事件处理器
      */
     has(key) {
-        return !!loader.handlerIds[key];
+        return !!loader.handler[key];
     }
 })();

package/lib/utils/tools/button.d.ts

@@ -1,2 +1,2 @@
 import { KarinMessageType } from '../../types/index.js';
-export declare const button: (e: KarinMessageType) => Promise<any>;
+export declare const button: (msg: string, e?: KarinMessageType) => Promise<any>;

package/lib/utils/tools/button.js

@@ -1,35 +1,24 @@
 import logger from '../core/logger.js';
 import { pluginLoader as loader } from '../../core/index.js';
-export const button = async (e) => {
+export const button = async (msg, e) => {
     const button = [];
-    for (const v of loader.buttonIds) {
-        const info = loader.PluginList[v];
-        for (const v of info.button) {
-            const reg = v.reg;
-            if (reg.test(e.msg)) {
-                try {
-                    let res;
-                    let done = true;
-                    /**
-                     * 标记函数 如果调用则继续执行 循环下一个按钮插件处理
-                     */
-                    const reject = () => { done = false; };
-                    if (typeof v.fnc === 'function') {
-                        res = await v.fnc(e, reject);
-                    }
-                    else {
-                        const cla = new info.file.Fnc();
-                        cla.e = e;
-                        res = await cla[v.fnc](e, reject);
-                    }
-                    if (res)
-                        button.push(res);
-                    if (done)
-                        return res;
-                }
-                catch (error) {
-                    logger.error(error);
-                }
+    for (const info of loader.button) {
+        const reg = info.reg;
+        if (reg.test(msg)) {
+            try {
+                let done = true;
+                /**
+                 * 标记函数 如果调用则继续执行 循环下一个按钮插件处理
+                 */
+                const reject = () => { done = false; };
+                const res = await info.fn(reject, e);
+                if (res)
+                    button.push(res);
+                if (done)
+                    return res;
+            }
+            catch (error) {
+                logger.error(error);
             }
         }
     }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "node-karin",
-  "version": "0.10.6",
+  "version": "0.11.0",
   "private": false,
   "description": "基于 Kritor 进行开发的nodejs机器人框架",
   "homepage": "https://github.com/KarinJS/Karin",

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

@@ -1,19 +0,0 @@
-import { dirName, fileName, PluginApps } from '../../types/index.js';
-export interface PluginAppType {
-    file?: {
-        dir?: dirName;
-        name?: fileName;
-        type?: PluginApps['file']['type'];
-        fnc?: PluginApps['file']['Fnc'];
-    };
-    name?: string;
-    event?: PluginApps['event'];
-    priority?: number;
-    accept?: boolean | Function;
-    log?: boolean;
-    rule?: PluginApps['rule'];
-    task?: PluginApps['task'];
-    handler?: PluginApps['handler'];
-    button?: PluginApps['button'];
-}
-export default function PluginApp(options: PluginAppType): PluginApps;

package/lib/core/plugin/app.js

@@ -1,19 +0,0 @@
-export default function PluginApp(options) {
-    return {
-        file: {
-            dir: options?.file?.dir || '',
-            name: options?.file?.name || '',
-            type: options?.file?.type || 'function',
-            Fnc: options?.file?.fnc || '',
-        },
-        name: options.name || '',
-        event: options.event || "message" /* EventType.Message */,
-        priority: options.priority || 10000,
-        accept: options.accept ?? false,
-        log: options.log ?? true,
-        rule: options.rule || [],
-        task: options.task || [],
-        handler: options.handler || [],
-        button: options.button || [],
-    };
-}