node-karin 0.3.9 → 0.4.1

package/lib/adapter/onebot/onebot11.js

@@ -146,7 +146,10 @@ export class OneBot11 {
             }, 100);
         });
     }
-    /** 处理事件 */
+    /**
+     * 处理事件
+     * - @param data ob11相关标准数据
+     */
     #event(data) {
         switch (data.post_type) {
             case 'meta_event': {

package/lib/core/karin.d.ts

@@ -7,10 +7,6 @@ export interface OptionsCommand {
      * - 插件名称 不传则使用 插件名称:函数名
      */
     name?: string;
-    /**
-     * - 插件描述
-     */
-    desc?: string;
     /**
      * - 插件优先级 数字越小优先级越高
      * @default 10000
@@ -66,5 +62,50 @@ export declare class Karin {
      * @param options - 选项
      */
     command(reg: string | RegExp, element: FncElement, options?: OptionsElement): PluginApps;
+    /**
+     * - 构建定时任务
+     * @param name - 任务名称
+     * @param cron - cron表达式
+     * @param fnc - 执行函数
+     * @param options - 选项
+     */
+    task(name: string, cron: string, fnc: Function, options?: {
+        /**
+         * - 任务插件名称
+         */
+        name?: string;
+        /**
+         * - 任务优先级
+         */
+        priority?: number;
+        /**
+         * - 是否打印日志 传递布尔值
+         */
+        log?: boolean | Function;
+    }): PluginApps;
+    /**
+     * - 构建handler
+     * @param key - 事件key
+     * @param fnc - 函数实现
+     * @param options - 选项
+     */
+    handler(key: string, fnc: (
+    /**
+     * - 自定义参数 由调用方传递
+     */
+    args: any, 
+    /**
+     * - 拒绝处理器 调用后则不再继续执行下一个处理器
+     */
+    reject: (msg?: string) => void) => Promise<any>, options?: {
+        /**
+         * - 插件名称
+         */
+        name?: string;
+        /**
+         * - handler优先级
+         */
+        priority?: number;
+    }): PluginApps;
 }
 export {};

package/lib/core/karin.js

@@ -8,6 +8,7 @@ export class Karin {
      * @param options - 选项
      * @returns - 返回插件对象
      */
+
   command (reg, second, options = {}) {
     const Reg = typeof reg === 'string' ? new RegExp(reg) : reg
     const data = {
@@ -29,7 +30,7 @@ export class Karin {
       case 'string':
       case 'number':
       case 'object': {
-        const element = common.makeMessage(typeof second === 'function' ? second : String(second))
+        const element = common.makeMessage(typeof second === 'number' ? String(second) : second)
         const fnc = async (e) => {
           if ('delay' in options && options.delay) { await common.sleep(options.delay) }
           await e.reply(element, {
@@ -48,4 +49,54 @@ export class Karin {
       }
     }
   }
+
+  /**
+     * - 构建定时任务
+     * @param name - 任务名称
+     * @param cron - cron表达式
+     * @param fnc - 执行函数
+     * @param options - 选项
+     */
+  task (name, cron, fnc, options) {
+    if (!name) { throw new Error('[task]: 缺少参数[name]') }
+    if (!cron) { throw new Error('[task]: 缺少参数[cron]') }
+    if (!fnc) { throw new Error('[task]: 缺少参数[fnc]') }
+    const data = {
+      name: options?.name || 'task',
+      priority: options?.priority,
+      task: [
+        {
+          name,
+          cron,
+          fnc,
+          log: options?.log ?? true,
+        },
+      ],
+    }
+    return PluginApp(data)
+  }
+
+  /**
+     * - 构建handler
+     * @param key - 事件key
+     * @param fnc - 函数实现
+     * @param options - 选项
+     */
+  handler (key, fnc, options) {
+    if (!key) { throw new Error('[handler]: 缺少参数[key]') }
+    if (!fnc) { throw new Error('[handler]: 缺少参数[fnc]') }
+    const priority = options?.priority || 10000
+    const data = {
+      name: options?.name || 'handler',
+      priority,
+      handler: [
+        {
+          key,
+          fnc,
+          priority,
+        },
+      ],
+    }
+    return PluginApp(data)
+  }
 }

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

@@ -9,7 +9,10 @@ export interface PluginAppType {
     name?: string;
     event?: PluginApps['event'];
     priority?: number;
-    accept?: boolean;
+    accept?: boolean | Function;
     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

@@ -11,8 +11,8 @@ export default function PluginApp (options) {
     priority: options.priority || 10000,
     accept: options.accept ?? false,
     rule: options.rule || [],
-    task: [],
-    handler: [],
-    button: [],
+    task: options.task || [],
+    handler: options.handler || [],
+    button: options.button || [],
   }
 }

package/lib/core/plugin.d.ts

@@ -1,11 +1,11 @@
-import { PluginType, KarinElement, KarinNodeElement, EventType } from '../types/index.js';
+import { PluginType, KarinElement, KarinNodeElement, EventType, KarinNoticeEvent, KarinRequestEvent } from '../types/index.js';
 /**
  * 插件基类
  */
 export declare class Plugin implements PluginType {
     e: EventType<this>;
     init?: () => void;
-    accept?: (e: EventType<this>) => Promise<void>;
+    accept?: (e: any) => Promise<void>;
     replyCallback: PluginType['replyCallback'];
     /**
      * @param name - 插件名称
@@ -178,3 +178,9 @@ export declare const stateArr: {
         fnc: string;
     };
 };
+/**
+ * 通知事件 插件类型
+ */
+export interface ExtendedPlugin extends Plugin {
+    accept: (e: KarinNoticeEvent | KarinRequestEvent) => Promise<void>;
+}

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

@@ -16,7 +16,14 @@ export declare const pluginLoader: {
      * - 命令插件索引列表
      */
     ruleIds: Array<number>;
+    /**
+     * - 按钮插件索引列表
+     */
     buttonIds: Array<number>;
+    /**
+     * - accept插件索引列表
+     */
+    acceptIds: Array<number>;
     /**
      * - handler
      */

package/lib/core/plugin.loader.js

@@ -21,7 +21,14 @@ export const pluginLoader = new (class PluginLoader {
      * - 命令插件索引列表
      */
   ruleIds
+  /**
+     * - 按钮插件索引列表
+     */
   buttonIds
+  /**
+     * - accept插件索引列表
+     */
+  acceptIds
   /**
      * - handler
      */
@@ -61,6 +68,7 @@ export const pluginLoader = new (class PluginLoader {
     this.PluginList = {}
     this.task = []
     this.ruleIds = []
+    this.acceptIds = []
     this.buttonIds = []
     this.handlerIds = {}
   }
@@ -181,15 +189,18 @@ export const pluginLoader = new (class PluginLoader {
     let handlerCount = 0
     const rule = []
     const button = []
+    const accept = []
     Object.keys(this.PluginList).forEach(key => {
       taskCount += this.PluginList[key].task.length
       if (this.PluginList[key].rule.length) { rule.push({ key, val: this.PluginList[key].priority }) }
       if (this.PluginList[key].button.length) { button.push({ key, val: this.PluginList[key].priority }) }
+      if (this.PluginList[key].accept) { accept.push({ key, val: this.PluginList[key].priority }) }
     })
     this.ruleIds = lodash.orderBy(rule, ['val'], ['asc']).map((v) => Number(v.key))
     logger.debug('rule排序完成...')
     this.buttonIds = lodash.orderBy(button, ['val'], ['asc']).map((v) => Number(v.key))
     logger.debug('button排序完成...')
+    this.acceptIds = lodash.orderBy(accept, ['val'], ['asc']).map((v) => Number(v.key))
     if (!isPrint) { return }
     const PluginListKeys = Object.keys(this.PluginList)
     const handlerKeys = Object.keys(this.handlerIds)
@@ -200,6 +211,7 @@ export const pluginLoader = new (class PluginLoader {
     logger.info(`[渲染器][${render.Apps.length}个] 加载完成`)
     logger.info(`[rule][${this.ruleIds.length}个] 加载完成`)
     logger.info(`[button][${this.buttonIds.length}个] 加载完成`)
+    logger.info(`[accept][${this.acceptIds.length}个] 加载完成`)
     logger.info(`[定时任务][${taskCount}个] 加载完成`)
     logger.info(`[Handler][Key:${handlerKeys.length}个][fnc:${handlerCount}个] 加载完成`)
     logger.info(logger.green('-----------'))
@@ -220,12 +232,36 @@ export const pluginLoader = new (class PluginLoader {
       lodash.forEach(tmp, (App) => {
         const index = this.index
         this.index++
-        if (typeof App === 'object') {
-          if (App?.file?.type !== 'function') { return }
+        if (typeof App === 'object' && App?.file?.type === 'function') {
           if (!App?.name) { return logger.error(`[${dir}][${name}] 插件名称错误`) }
           App.file.dir = dir
           App.file.name = name
+          /** handler */
+          handler.add(index + '', App)
+          const task = []
+          /** 定时任务 */
+          lodash.forEach(App.task, val => {
+            task.push({
+              name: val.name,
+              cron: val.cron,
+              fnc: val.fnc,
+              log: val.log === false ? (log) => logger.debug(log) : (log) => logger.mark(log),
+              schedule: schedule.scheduleJob(val.cron, async () => {
+                try {
+                  typeof val.log === 'function' && val.log(`[定时任务][${dir}][${val.name}] 开始执行`)
+                  if (typeof val.fnc === 'function') { await val.fnc() }
+                  typeof val.log === 'function' && val.log(`[定时任务][${dir}][${val.name}] 执行完毕`)
+                } catch (error) {
+                  logger.error(`[定时任务][${dir}][${val.name}] 执行报错`)
+                  logger.error(error)
+                }
+              }),
+            })
+          })
+          App.task = task
           this.PluginList[index] = App
+          if (App.accept) { this.acceptIds.push(index) }
+          return true
         }
         if (typeof App !== 'function' || !App?.prototype?.constructor) { return }
         const Class = new App()
@@ -288,16 +324,13 @@ export const pluginLoader = new (class PluginLoader {
             fnc: val.fnc,
           })
         })
+        /** accept */
+        if (Class.accept && typeof Class.accept === 'function') { this.acceptIds.push(index) }
         /** handler */
         handler.add(index + '', Class)
         /** 执行初始化 */
         Class.init && Class.init()
         this.PluginList[index] = info
-        // const Class = new App()
-        /** 注册Handler */
-        // if (!lodash.isEmpty(Class.handler)) handler.add({ name, dir, App, Class })
-        /** 注册按钮 */
-        // if (!lodash.isEmpty(Class.button)) button.add({ name, dir, App, Class })
         return true
       })
       // rule收集并排序
@@ -325,16 +358,20 @@ export const pluginLoader = new (class PluginLoader {
      * 卸载插件
      */
   uninstallApp (dir, name) {
-    // this.Apps = this.Apps.filter((v) => !(v.file.dir === dir && v.file.name === name))
-    // this.uninstallTask(dir, name)
-    // button.del(dir, name)
-    // handler.del({ dir, name, key: '' })
+    const index = []
     Object.keys(this.PluginList).forEach(key => {
       const info = this.PluginList[key]
       /** 停止定时任务 */
       info.task.forEach(val => val.schedule?.cancel())
-      info.file.dir === dir && info.file.name === name && delete this.PluginList[key]
+      if (info.file.dir === dir && info.file.name === name) {
+        index.push(key)
+        delete this.PluginList[key]
+      }
     })
+    /** 删除handler */
+    index.forEach(key => handler.del(key))
+    /** 重新排序 */
+    this.orderBy()
   }
 
   /**

package/lib/db/index.d.ts

@@ -1,4 +1,2 @@
-import LevelDB from './level.js';
-import { RedisClientType } from 'redis';
-export declare const level: LevelDB;
-export declare const redis: RedisClientType;
+export * from './level.js';
+export * from './redis.js';

package/lib/db/index.js

@@ -1,4 +1,2 @@
-import Redis from './redis.js'
-import LevelDB from './level.js'
-export const level = new LevelDB()
-export const redis = await new Redis().start()
+export * from './level.js'
+export * from './redis.js'

package/lib/db/level.d.ts

@@ -16,3 +16,4 @@ export default class LevelDB extends Level {
      */
     set(key: string, value: string | object): Promise<void>;
 }
+export declare const level: LevelDB;

package/lib/db/level.js

@@ -34,3 +34,4 @@ export default class LevelDB extends Level {
     return await super.put(key, value)
   }
 }
+export const level = new LevelDB()

package/lib/db/redis.d.ts

@@ -1,41 +1,2 @@
-import RedisLevel from './redis_level.js';
-import redis from 'redis';
-export default class Redis {
-    id: 'redis';
-    RunCmd: string;
-    constructor();
-    /**
-     * redis实例化
-     */
-    start(): Promise<(redis.RedisClientType | string) | RedisLevel | false>;
-    /**
-     * 降级为 LevelDB
-     */
-    LevelDB(): Promise<false | RedisLevel>;
-    /**
-     * 连接 Redis 单例
-     * @param {import("redis").RedisClientOptions} options
-     * @return {Promise<{status: 'ok', data: import("redis").RedisClientType} | {status: 'error', data: Error}>}
-     */
-    connect(options: redis.RedisClientOptions): Promise<{
-        status: 'ok';
-        data: redis.RedisClientType;
-    } | {
-        status: 'error';
-        data: string;
-    }>;
-    /**
-     * 连接 Redis 集群
-     */
-    connectCluster(rootNodes: {
-        url: string;
-    }[]): Promise<{
-        status: string;
-        data: unknown;
-    }>;
-    /**
-     * 判断是否为 ARM64 并返回参数
-     */
-    aarch64(): Promise<string>;
-    execSync(cmd: string): Promise<string>;
-}
+import { RedisClientType } from 'redis';
+export declare const redis: RedisClientType;

package/lib/db/redis.js

@@ -2,7 +2,7 @@ import { exec } from 'child_process'
 import RedisLevel from './redis_level.js'
 import { logger, config } from '../utils/index.js'
 import { createClient, createCluster } from 'redis'
-export default class Redis {
+class Redis {
   id
   RunCmd
   constructor () {
@@ -76,8 +76,6 @@ export default class Redis {
 
   /**
      * 连接 Redis 单例
-     * @param {import("redis").RedisClientOptions} options
-     * @return {Promise<{status: 'ok', data: import("redis").RedisClientType} | {status: 'error', data: Error}>}
      */
   async connect (options) {
     const client = createClient(options)
@@ -134,3 +132,4 @@ export default class Redis {
     })
   }
 }
+export const redis = await new Redis().start()

package/lib/event/event.d.ts

@@ -1,4 +1,4 @@
-import { KarinAdapter, Reply, replyCallback, Event, contact, Sender, SubEventForEvent } from '../types/index.js';
+import { KarinAdapter, Reply, replyCallback, Event, contact, Sender, EventToSubEvent } from '../types/index.js';
 /**
  * - 事件基类 所有事件都继承自此类并且需要实现此类的所有属性
  * @class KarinEvent
@@ -24,7 +24,7 @@ export declare class KarinEvent {
     /**
      * - 事件子类型
      */
-    sub_event: SubEventForEvent<Event>;
+    sub_event: EventToSubEvent[Event];
     /**
      * - 事件ID
      */
@@ -83,6 +83,10 @@ export declare class KarinEvent {
      * - 存储器 由开发者自行调用
      */
     store: Map<string, any>;
+    /**
+     * - 原始消息
+     */
+    raw_message: string;
     /**
      * - 回复函数
      */
@@ -127,7 +131,7 @@ export declare class KarinEvent {
         /**
          * - 事件子类型
          */
-        sub_event: SubEventForEvent<Event>;
+        sub_event: EventToSubEvent[Event];
         /**
          * - 事件ID
          */

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

@@ -1,14 +1,15 @@
-import { KarinMessage } from './message.js';
-import { KarinNotice } from './notice.js';
-import { KarinRequest } from './request.js';
-import { Event, Permission, SubEvent, GroupCfg } from '../types/index.js';
+import { Event, Permission, SubEvent, GroupCfg, KarinMessageEvent, KarinNoticeEvent, KarinRequestEvent } from '../types/index.js';
 export default class EventHandler {
-    e: KarinMessage | KarinNotice | KarinRequest;
+    e: KarinMessageEvent | KarinNoticeEvent | KarinRequestEvent;
     config: GroupCfg | {};
+    /**
+     * - 是否打印群消息日志
+     */
+    GroupMsgPrint: boolean;
     /**
      * 处理事件，加入自定义字段
      */
-    constructor(e: KarinMessage | KarinNotice | KarinRequest);
+    constructor(e: KarinMessageEvent | KarinNoticeEvent | KarinRequestEvent);
     /**
      * 事件处理
      */

package/lib/event/event.handler.js

@@ -4,12 +4,17 @@ import { segment, common, logger, config } from '../utils/index.js'
 export default class EventHandler {
   e
   config
+  /**
+     * - 是否打印群消息日志
+     */
+  GroupMsgPrint
   /**
      * 处理事件，加入自定义字段
      */
   constructor (e) {
     this.e = e
     this.config = {}
+    this.GroupMsgPrint = false
     /** 加入e.bot */
     Object.defineProperty(this.e, 'bot', { value: listener.getBot(this.e.self_id) })
     if (this.e.group_id) { this.config = config.group(this.e.group_id) }

package/lib/event/event.js

@@ -82,6 +82,10 @@ export class KarinEvent {
      * - 存储器 由开发者自行调用
      */
   store
+  /**
+     * - 原始消息
+     */
+  raw_message
   /**
      * - 回复函数
      */
@@ -113,6 +117,7 @@ export class KarinEvent {
     this.logFnc = ''
     this.logText = ''
     this.store = new Map()
+    this.raw_message = ''
     this.reply = (elements, options) => Promise.resolve({ message_id: '' })
     this.replyCallback = (elements, options) => Promise.resolve({ message_id: '' })
     this.bot = {}

package/lib/event/index.js

@@ -3,7 +3,7 @@ export * from './event.handler.js'
 export * from './message.js'
 export * from './message.handler.js'
 export * from './notice.js'
-// export * from './notice.handler'
+// export * from './notice.handler.js'
 export * from './request.js'
-// export * from './request.handler'
+// export * from './request.handler.js'
 export * from './review.handler.js'

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

@@ -1,15 +1,15 @@
-import { KarinMessage } from './message.js';
 import EventHandler from './event.handler.js';
+import { KarinMessageEvent } from '../types/index.js';
 /**
  * 消息事件
  */
 export declare class MessageHandler extends EventHandler {
-    e: KarinMessage;
+    e: KarinMessageEvent;
     /**
      * - 是否打印群消息日志
      */
     GroupMsgPrint: boolean;
-    constructor(e: KarinMessage);
+    constructor(e: KarinMessageEvent);
     /**
      * 处理消息
      */

package/lib/event/message.handler.js

@@ -56,19 +56,18 @@ export class MessageHandler extends EventHandler {
           this.GroupMsgPrint && typeof v.log === 'function' && v.log(this.e.self_id, `${logFnc}${this.e.logText} ${lodash.truncate(this.e.msg, { length: 80 })}`)
           /** 判断权限 */
           if (!this.filterPermission(v.permission)) { break a }
+          /** 计算插件处理时间 */
+          const start = Date.now()
+          listener.emit('karin:count:fnc', this.e.logFnc)
           try {
             let res
             if (app.file.type === 'function' && typeof v.fnc === 'function') {
-              res = v.fnc(this.e)
+              res = await v.fnc(this.e)
             } else {
               const cla = new app.file.Fnc()
               cla.e = this.e
-              res = cla[v.fnc](this.e)
+              res = await cla[v.fnc](this.e)
             }
-            /** 计算插件处理时间 */
-            const start = Date.now()
-            listener.emit('karin:count:fnc', this.e.logFnc)
-            res = await res
             this.GroupMsgPrint && typeof v.log === 'function' && v.log(this.e.self_id, `${logFnc} ${lodash.truncate(this.e.msg, { length: 80 })} 处理完成 ${logger.green(Date.now() - start + 'ms')}`)
             if (res !== false) { break a }
           } catch (error) {
@@ -191,16 +190,14 @@ export class MessageHandler extends EventHandler {
     this.e.raw_message = logs.join('')
     /** 前缀处理 */
     this.e.group_id && 'GroupCD' in this.config && review.alias(this.e, this.config)
-    /** 主人 这里强制是因为yaml在自动保存QQ号的时候会强制化为数字 */
-    const masterId = (Number(this.e.user_id) || String(this.e.user_id))
-    if (config.master.includes(masterId)) {
+    /** 主人 */
+    if (config.master.includes(String(this.e.user_id))) {
       this.e.isMaster = true
       this.e.isAdmin = true
-    } else if (config.admin.includes(masterId)) {
+    } else if (config.admin.includes(String(this.e.user_id))) {
       /** 管理员 */
       this.e.isAdmin = true
     }
-    this.GroupMsgPrint = false
     if (this.e.contact.scene === 'private') {
       this.e.isPrivate = true
       this.e.logText = `[Private:${this.e.sender.nick || ''}(${this.e.user_id})]`

package/lib/event/notice.d.ts

@@ -1,5 +1,5 @@
 import { KarinEvent } from './event.js';
-import { contact, Sender, SubEventForEvent, NoticeEvent } from '../types/index.js';
+import { contact, Sender, NoticeType, EventToSubEvent } from '../types/index.js';
 /**
  * - 通知事件基类
  */
@@ -32,11 +32,11 @@ export declare class KarinNotice extends KarinEvent {
         /**
          * 事件子类型
          */
-        sub_event: SubEventForEvent<'notice'>;
+        sub_event: EventToSubEvent['notice'];
         /**
          * 事件对应的内容参数
          */
-        content: NoticeEvent<SubEventForEvent<'notice'>>;
+        content: NoticeType[EventToSubEvent['notice']];
         /**
          * 群ID
          */
@@ -45,5 +45,5 @@ export declare class KarinNotice extends KarinEvent {
     /**
      * - 事件对应的内容参数
      */
-    content: NoticeEvent<SubEventForEvent<'notice'>>;
+    content: NoticeType[EventToSubEvent['notice']];
 }

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

@@ -0,0 +1,17 @@
+import EventHandler from './event.handler.js';
+import { KarinNoticeEvent } from '../types/index.js';
+/**
+ * 通知事件
+ */
+export default class NoticeHandler extends EventHandler {
+    e: KarinNoticeEvent;
+    constructor(e: KarinNoticeEvent);
+    /**
+     * 处理事件
+     */
+    deal(): Promise<void>;
+    /**
+     * 构建原始消息
+     */
+    raw_message(): void;
+}