node-karin 0.2.1 → 0.3.0

package/lib/index.d.ts

@@ -4,7 +4,7 @@ export * from 'kritor-proto';
 export * from './core/index.js';
 export * from './event/index.js';
 export * from './db/index.js';
-export * from './renderer/index.js';
+export * from './render/index.js';
 export * from './utils/index.js';
 export * from './types/index.js';
 import { Karin, Plugin } from './core/index.js';
@@ -66,9 +66,6 @@ export declare const Bot: {
     adapter: {
         type: "internal" | "http" | "grpc" | "ws" | "render";
         adapter: new () => import("./types/index.js").KarinAdapter;
-        /**
-         * @description 即将废弃，请使用 `Plugin`
-        */
         path: string;
     }[];
     addBot(data: {
@@ -92,9 +89,6 @@ export declare const Bot: {
     getAdapterAll(isType?: boolean): {
         type: "internal" | "http" | "grpc" | "ws" | "render";
         adapter: new () => import("./types/index.js").KarinAdapter;
-        /**
-         * @description 即将废弃，请使用 `Plugin`
-        */
         path: string;
     }[] | (new () => import("./types/index.js").KarinAdapter)[];
     sendMsg(uid: string, contact: import("./types/index.js").contact, elements: import("./types/index.js").KarinElement, options?: {

package/lib/index.js

@@ -3,17 +3,17 @@ export * from 'kritor-proto';
 export * from './core/index.js';
 export * from './event/index.js';
 export * from './db/index.js';
-export * from './renderer/index.js';
+export * from './render/index.js';
 export * from './utils/index.js';
 export * from './types/index.js';
 import { config, update } from './utils/index.js';
-import { render } from './renderer/index.js';
-import { RenderServer } from './renderer/index.js';
+import { render } from './render/index.js';
+import { RenderServer } from './render/index.js';
 import OneBot11 from './adapter/onebot/onebot11.js';
-import { server, Karin, PluginLoader, listener, Plugin } from './core/index.js';
+import { server, Karin, listener, Plugin } from './core/index.js';
 // 初始化
 server.init();
-PluginLoader.load();
+listener.emit('load.plugin');
 listener.emit('adapter', RenderServer);
 listener.emit('adapter', OneBot11);
 /**

package/lib/tools/init.js

@@ -24,7 +24,7 @@ for (const dir of delList) {
   }
 }
 // 判断是否为第一次使用
-if (!fs.existsSync('./index.js') && !fs.existsSync('./plugins')) {
+if (!fs.existsSync('./index.js')) {
   // 创建一个index.js文件 以供初次开箱使用，写入默认配置
   fs.writeFileSync('./index.js', `import { Bot } from 'node-karin'
 console.log(Bot.name + '开始初始化~')

package/lib/types/event.d.ts

@@ -890,7 +890,18 @@ export interface GroupHonorInfo {
      */
     description: string;
 }
+export interface EMap {
+    message: KarinMessage;
+    notice: KarinNotice;
+    request: KarinRequest;
+    message_sent: KarinMessage;
+    meta_event: any;
+}
+export type E<T extends keyof EMap> = EMap[T];
+export type EType = KarinMessage | KarinNotice | KarinRequest;
 /**
- * - e
+ * 根据accept函数是否存在来决定e的类型
  */
-export type E = KarinMessage | KarinNotice | KarinRequest;
+export type EventType<T> = T extends {
+    accept: (e: any) => Promise<void>;
+} ? KarinNotice | KarinRequest : KarinMessage;

package/lib/types/plugin.d.ts

@@ -2,7 +2,7 @@
 import schedule from 'node-schedule';
 import { KarinNodeElement } from './element.js';
 import { Reply, replyCallback } from './reply.js';
-import { E, Event, Permission, SubEvent } from './event.js';
+import { EventType, Event, Permission, SubEvent } from './event.js';
 /**
  * - 插件根目录名称
  * - 例如: karin-plugin-example
@@ -71,15 +71,11 @@ export interface PluginButton {
     /**
      * - 按钮命令正则
      */
-    reg: string;
+    reg: string | RegExp;
     /**
      * - 执行方法名称
      */
-    fnc: string;
-    /**
-     * - 优先级 不填默认为主优先度
-     */
-    priority: number;
+    fnc: string | Function;
 }
 /**
  * - handler规则
@@ -137,7 +133,7 @@ export interface PluginType {
      */
     event: Event | `${Event}.${SubEvent}`;
     /**
-     * - 优先级 默认为5000
+     * - 优先级 默认为10000
      */
     priority: number;
     /**
@@ -166,8 +162,9 @@ export interface PluginType {
     timeout: NodeJS.Timeout | undefined;
     /**
      * - 上报事件
+     * - 根据上报中的event字段来获取e的事件类型
      */
-    e: E;
+    e: EventType<this>;
     /**
      * - 快速回复
      */
@@ -218,7 +215,7 @@ export interface PluginType {
     /**
      * - accept标准方法 给通知、请求事件使用
      */
-    accept?(e: E): Promise<void>;
+    accept?(e: EventType<this>): Promise<void>;
 }
 /**
  * 上下文状态

package/lib/utils/button.d.ts

@@ -1,48 +1,2 @@
 import { KarinMessage } from '../event/message.js';
-import { PluginType, dirName, fileName } from '../types/plugin.js';
-export declare const button: {
-    Apps: Array<{
-        App: new () => PluginType;
-        name: string;
-        priority: number;
-        file: {
-            dir: dirName;
-            name: fileName;
-        };
-        rule: Array<{
-            reg: RegExp;
-            fnc: string;
-        }>;
-    }>;
-    add({ name, dir, App, Class }: {
-        dir: dirName;
-        name: fileName;
-        App: new () => PluginType;
-        Class: PluginType;
-    }): void;
-    /**
-     * 卸载按钮
-     * @param {string} dir 插件目录
-     * @param {string} name 插件文件名称
-     */
-    del(dir: dirName, name: fileName): {
-        App: new () => PluginType;
-        name: string;
-        priority: number;
-        file: {
-            dir: dirName;
-            name: fileName;
-        };
-        rule: Array<{
-            reg: RegExp;
-            fnc: string;
-        }>;
-    }[];
-    update({ dir, name, App, Class }: {
-        dir: dirName;
-        name: fileName;
-        App: new () => PluginType;
-        Class: PluginType;
-    }): void;
-    get(e: KarinMessage): Promise<any[]>;
-};
+export declare const button: (e: KarinMessage) => Promise<any>;

package/lib/utils/button.js

@@ -1,79 +1,35 @@
-import lodash from 'lodash'
 import logger from './logger.js'
-export const button = new (class Button {
-  Apps
-  constructor () {
-    this.Apps = []
-  }
-
-  add ({ name, dir, App, Class }) {
-    const rule = []
-    /** 创建正则表达式 */
-    for (const v of Class.button) {
-      try {
-        const { reg, fnc } = v
-        rule.push({ reg: new RegExp(reg), fnc })
-      } catch (error) {
-        logger.error(error)
-        continue
-      }
-    }
-    this.Apps.push({
-      App,
-      name: Class.name,
-      priority: Class.priority,
-      file: { name, dir },
-      rule,
-    })
-  }
-
-  /**
-     * 卸载按钮
-     * @param {string} dir 插件目录
-     * @param {string} name 插件文件名称
-     */
-  del (dir, name) {
-    /** 未传入name则删除所有 */
-    if (!name) {
-      this.Apps = this.Apps.filter(v => v.file.dir !== dir)
-    } else {
-      /** 传入name则删除指定 */
-      this.Apps = this.Apps.filter(v => v.file.dir !== dir || v.file.name !== name)
-    }
-    /** 排序 */
-    this.Apps = lodash.orderBy(this.Apps, ['priority'], ['asc'])
-    return this.Apps
-  }
-
-  update ({ dir, name, App, Class }) {
-    this.del(dir, name)
-    this.add({ name, dir, App, Class })
-  }
-
-  async get (e) {
-    const button = []
-    for (const app of this.Apps) {
-      for (const v of app.rule) {
-        /** 这里的lastIndex是为了防止正则无法从头开始匹配 */
-        v.reg.lastIndex = 0
-        if (v.reg.test(e.msg)) {
-          try {
-            const App = new app.App()
-            App.e = e
-            const res = await App[v.fnc](e)
-            if (!res) { continue }
-            /** 是否继续循环 */
-            const cycle = res.cycle ?? true
-            delete res.cycle
-            button.push(res)
-            if (cycle !== false) { return button }
-          } catch (error) {
-            logger.error(error)
+import { pluginLoader as loader } from '../core/index.js'
+export const button = async (e) => {
+  const button = []
+  for (const v of loader.buttonIds) {
+    const info = loader.PluginList[v]
+    for (const v of info.button) {
+      const reg = v.reg
+      /** 这里的lastIndex是为了防止正则无法从头开始匹配 */
+      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)
         }
       }
     }
-    /** 理论上不会走到这里，但是还是要稳一手，不排除有所有插件都false... */
-    return button
   }
-})()
+  /** 理论上不会走到这里，但是还是要稳一手，不排除有所有插件都false... */
+  return button
+}

package/lib/utils/config.js

@@ -238,11 +238,11 @@ export const config = new (class Cfg {
     /** 修改日志等级 */
     this.loggger.level = this.Config.log4jsCfg.level
     await this.#review()
-    // if (this.Server.HotUpdate) {
-    //   const { Bot } = await import('../index.js')
-    //   Bot.emit('restart_http', {})
-    //   Bot.emit('restart_grpc', {})
-    // }
+    if (this.Server.HotUpdate) {
+      const { Bot } = await import('../index.js')
+      Bot.emit('restart_http', {})
+      Bot.emit('restart_grpc', {})
+    }
   }
 
   async change_group () {
@@ -250,10 +250,10 @@ export const config = new (class Cfg {
   }
 
   async #review () {
-    // if (this.review) return
-    // this.review = true
-    // const review = await import('../event/review')
-    // review.default.main()
-    // this.review = false
+    if (this.review) { return }
+    this.review = true
+    const { review } = await import('../event/index.js')
+    review.main()
+    this.review = false
   }
 })()

package/lib/utils/handler.d.ts

@@ -1,64 +1,25 @@
-import { Plugin } from '../core/index.js';
-import { dirName, fileName } from '../types/index.js';
+import { EventType, PluginType } from '../types/index.js';
 /**
  * 事件处理器类
  */
 export declare const handler: {
-    events: {
-        [key: string]: {
-            /**
-             * - 文件信息
-             */
-            file: {
-                /**
-                 * - 插件包名称
-                 */
-                dir: dirName;
-                /**
-                 * - 文件名称
-                 */
-                name: fileName;
-            };
-            /**
-             * - 事件class
-             */
-            App: new () => Plugin;
-            /**
-             * - 事件键
-             */
-            key: string;
-            /**
-             * - 事件处理函数名称
-             */
-            fnc: string;
-            /**
-             * - 优先级
-             */
-            priority: number;
-        }[];
-    };
     /**
      * 添加事件处理器
-     * @param {Object} config 配置对象
-     * @param {string} config.name 处理器名称
-     * @param {string} config.dir 处理器所在目录
-     * @param {Function} config.App 应用构造函数
-     * @param {Object} config.Class 类配置
+     * @param index 插件索引
+     * @param Class 插件类
      */
-    add({ name, dir, App, Class }: {
-        dir: dirName;
-        name: fileName;
-        App: new () => Plugin;
-        Class: Plugin;
-    }): void;
+    add(index: string, Class: PluginType): void;
     /**
      * 删除事件处理器
+     * 如果不传参数则删除所有处理器
      */
-    del({ dir, name, key, }: {
-        dir: dirName | '';
-        name: fileName | '';
+    del({ index, key }: {
         /**
-         * 事件键 未传入则删除所有处理器
+         * 插件索引
+         */
+        index: string | '';
+        /**
+         * 事件键
          */
         key: string | '';
     }): boolean;
@@ -67,7 +28,9 @@ export declare const handler: {
      * @param key 事件键
      * @param args 自定义参数 一般用来传递e之类的
      */
-    call(key: string, args?: {}): Promise<any>;
+    call(key: string, args?: {
+        e?: EventType<unknown>;
+    }): Promise<any>;
     /**
      * 检查是否存在指定键的事件处理器
      */

package/lib/utils/handler.js

@@ -1,64 +1,62 @@
-import util from 'util'
 import lodash from 'lodash'
 import logger from './logger.js'
+import { pluginLoader as loader } from '../core/index.js'
 /**
  * 事件处理器类
  */
 export const handler = new (class EventHandler {
-  events
-  constructor () {
-    this.events = {}
-  }
-
   /**
      * 添加事件处理器
-     * @param {Object} config 配置对象
-     * @param {string} config.name 处理器名称
-     * @param {string} config.dir 处理器所在目录
-     * @param {Function} config.App 应用构造函数
-     * @param {Object} config.Class 类配置
+     * @param index 插件索引
+     * @param Class 插件类
      */
-  add ({ name, dir, App, Class }) {
-    for (const cfg of Class.handler) {
-      const { key = '', fnc = '', priority = 2000 } = cfg
-      if (!key) {
-        return logger.error(`[Handler][Add]: [${name}] 缺少 key`)
-      }
-      if (!fnc) {
-        return logger.error(`[Handler][Add]: [${name}] 缺少 fnc`)
-      }
-      logger.debug(`[Handler][Reg]: [${name}][${key}]`)
-      if (!Array.isArray(this.events[key])) { this.events[key] = [] }
-      this.events[key].push({ file: { name, dir }, App, key, fnc, priority })
-      this.events[key] = lodash.orderBy(this.events[key], ['priority'], ['asc'])
-    }
+  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'])
+    })
   }
 
   /**
      * 删除事件处理器
+     * 如果不传参数则删除所有处理器
      */
-  del ({ dir = '', name = '', key = '' }) {
-    /** 这里是删除所有 全部重新初始化 */
-    if (!key && !dir && !name) {
-      this.events = {}
+  del ({ index = '', key = '' }) {
+    /** 无参 */
+    if (!key && !index) {
+      loader.handlerIds = {}
       return true
     }
-    /** 热重载 删除指定目录 */
+    /** 删除指定索引插件 */
     if (!key) {
-      for (const v of Object.keys(this.events)) {
-        this.events[v] = this.events[v].filter(v => v.file.dir !== dir || v.file.name !== name)
+      for (const v of Object.keys(loader.handlerIds)) {
+        loader.handlerIds[v] = loader.handlerIds[v].filter(v => v.index !== index)
         // 如果处理器为空则删除键
-        if (!this.events[v].length) {
-          delete this.events[v]
+        if (!loader.handlerIds[v].length) {
+          delete loader.handlerIds[v]
         } else {
-          this.events[v] = lodash.orderBy(this.events[v], ['priority'], ['asc'])
+          loader.handlerIds[v] = lodash.orderBy(loader.handlerIds[v], ['priority'], ['asc'])
         }
       }
       return true
     }
-    if (!this.events[key]) { return false }
-    this.events[key] = this.events[key].filter(v => v.file.dir !== dir || v.file.name !== name)
-    this.events[key] = lodash.orderBy(this.events[key], ['priority'], ['asc'])
+    /** 删除指定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
   }
 
@@ -68,35 +66,42 @@ export const handler = new (class EventHandler {
      * @param args 自定义参数 一般用来传递e之类的
      */
   async call (key, args = {}) {
-    let ret
-    for (const v of this.events[key] || []) {
-      const App = new v.App()
-      if ('e' in args && args.e) { App.e = args.e }
-      let done = true
-      // 标记函数，用于标记处理器是否执行成功，由处理器自行调用，如果未调用则认为处理器未执行成功
-      const reject = (msg = '') => {
-        if (msg) { logger.mark(`[Handler][Reject]: [${v.file.dir}][${v.file.name}][${key}] ${msg}`) }
-        done = false
-      }
+    let res
+    for (const v of loader.handlerIds[key] || []) {
+      const info = loader.PluginList[v.index]
       try {
-        ret = await App[v.fnc](args, reject)
-        if (util.types.isPromise(ret)) { ret = await ret }
+        let done = true
+        /**
+                 * 拒绝处理器 调用后则不再继续执行下一个处理器
+                 * @param msg 错误信息
+                 */
+        const reject = (msg = '') => {
+          if (msg) { logger.mark(`[Handler][Reject]: [${info.file.dir}][${info.file.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()
+          cla.e = args.e
+          res = await cla[v.fnc](args, reject)
+        }
         if (done) {
-          logger.mark(`[Handler][Done]: [${v.file.dir}][${v.file.name}][${key}]`)
-          return ret
+          logger.mark(`[Handler][Done]: [${info.file.dir}][${info.file.name}][${key}]`)
+          return res
         }
       } catch (e) {
         // 产生错误继续下一个处理器
-        logger.error(`[Handler][Error]: [${v.file.dir}][${v.file.name}][${key}] ${e}`)
+        logger.error(`[Handler][Error]: [${info.file.dir}][${info.file.name}][${key}] ${e}`)
       }
     }
-    return ret
+    return res
   }
 
   /**
      * 检查是否存在指定键的事件处理器
      */
   has (key) {
-    return !!this.events[key]
+    return !!loader.handlerIds[key]
   }
 })()

package/package.json

@@ -1,7 +1,8 @@
 {
   "name": "node-karin",
-  "version": "0.2.1",
+  "version": "0.3.0",
   "private": false,
+  "description": "基于 Kritor 进行开发的nodejs机器人框架",
   "homepage": "https://github.com/KarinJS/Karin",
   "bugs": {
     "url": "https://github.com/KarinJS/Karin/issues"
@@ -41,8 +42,7 @@
     "init": "node lib/tools/install.js",
     "init:dev": "node lib/tools/install.js",
     "init:pack": "node lib/tools/install.js",
-    "js": "node .",
-    "js:dev": "node . --dev",
+    "dev": "tsx ./lib/index.js --dev",
     "log": "node lib/tools/pm2Log.js",
     "monit": "pm2 monit",
     "pub": "npm publish --access public",
@@ -50,8 +50,6 @@
     "sort:pack": "npx sort-package-json",
     "start": "pm2 start ./config/config/pm2.yaml && pm2 monit",
     "stop": "pm2 delete ./config/config/pm2.yaml",
-    "ts": "tsx ./src/index.ts --dev",
-    "ts:dev": "tsx ./src/index.ts --dev",
     "uninstall": "node lib/tools/uninstall.js",
     "ver": "node lib/tools/updateVersion.js"
   },
@@ -80,7 +78,7 @@
     "@types/node-schedule": "^2.1.7",
     "@types/ws": "8.5.10",
     "eslint": "9.5.0",
-    "neostandard": "^0.7.2",
+    "neostandard": "^0.9.0",
     "sort-package-json": "^2.10.0",
     "tsc-alias": "^1.8.10",
     "tsx": "^4.15.7",