node-karin 0.3.9 → 0.5.0

package/lib/adapter/onebot/onebot11.js

@@ -12,10 +12,6 @@ export class OneBot11 {
      * 是否初始化
      */
     #init = false;
-    /**
-     * 机器人QQ号
-     */
-    self_id;
     /**
      * - 重连次数 仅正向ws使用
      */
@@ -25,7 +21,6 @@ export class OneBot11 {
     adapter;
     version;
     constructor() {
-        this.self_id = '';
         this.index = 0;
         this.account = { uid: '', uin: '', name: '' };
         this.adapter = { id: 'QQ', name: 'OneBot11', type: 'ws', sub_type: 'internal', start_time: Date.now(), connect: '' };
@@ -108,6 +103,9 @@ export class OneBot11 {
         await this.getSelf();
         this.#init = true;
     }
+    get self_id() {
+        return this.account.uid || this.account.uin;
+    }
     /**
      * 获取当前登录号信息
      */
@@ -146,7 +144,10 @@ export class OneBot11 {
             }, 100);
         });
     }
-    /** 处理事件 */
+    /**
+     * 处理事件
+     * - @param data ob11相关标准数据
+     */
     #event(data) {
         switch (data.post_type) {
             case 'meta_event': {
@@ -534,7 +535,6 @@ export class OneBot11 {
     }
     /**
      * onebot11转karin
-     * @param {Array<{type: string, data: any}>} data onebot11格式消息
      * @return karin格式消息
      * */
     AdapterConvertKarin(data) {
@@ -590,12 +590,9 @@ export class OneBot11 {
     /**
      * karin转onebot11
      * @param data karin格式消息
-     * @return {Array<{type: string, data: any}>} onebot11格式消息
      * */
     KarinConvertAdapter(data) {
         const elements = [];
-        // const selfUin = this.account.uin
-        // const selfNick = this.account.name
         for (const i of data) {
             switch (i.type) {
                 case 'text':
@@ -616,37 +613,35 @@ export class OneBot11 {
                     elements.push({ type: i.type, data: { file: i.file } });
                     break;
                 }
-                case 'xml':
+                case 'xml': {
+                    elements.push({ type: 'xml', data: { data: i.data } });
+                    break;
+                }
                 case 'json': {
-                    elements.push({ type: i.type, data: { data: i.data } });
+                    elements.push({ type: 'json', data: { data: i.data } });
                     break;
                 }
-                // case 'node': {
-                //   let { type, user_id = selfUin, nickname = selfNick, content } = i
-                //   content = this.KarinConvertAdapter(content)
-                //   elements.push({ type, data: { uin: user_id, name: nickname, content } })
-                //   break
-                // }
                 case 'forward': {
                     elements.push({ type: 'forward', data: { id: i.res_id } });
                     break;
                 }
+                case 'record':
                 case 'voice': {
                     elements.push({ type: 'record', data: { file: i.file, magic: i.magic || false } });
                     break;
                 }
                 case 'music': {
-                    // if (i.platform) {
-                    //   elements.push({ type: 'music', data: { type: i.platform, id: i.id } })
-                    // } else {
-                    //   const { url, audio, title, content, image } = i
-                    //   elements.push({ type: 'music', data: { type: 'custom', url, audio, title, content, image } })
-                    // }
+                    if (i.id) {
+                        elements.push({ type: 'music', data: { type: i.platform, id: i.id } });
+                    }
+                    else {
+                        const { url, audio, title, author, pic } = i;
+                        elements.push({ type: 'music', data: { type: 'custom', url, audio, title, content: author, image: pic } });
+                    }
                     break;
                 }
                 case 'button': {
-                    // todo
-                    // elements.push({ type: 'button', data: { buttons: i.buttons } })
+                    elements.push({ type: 'button', data: i.data });
                     break;
                 }
                 case 'markdown': {
@@ -654,19 +649,51 @@ export class OneBot11 {
                     elements.push({ type, data: { ...data } });
                     break;
                 }
-                // case 'rows': {
-                //   for (const val of i.rows) {
-                //     elements.push({ type: 'button', data: { buttons: val.buttons } })
-                //   }
-                //   break
-                // }
+                case 'rows': {
+                    for (const val of i.rows) {
+                        elements.push({ type: 'button', data: val.data });
+                    }
+                    break;
+                }
                 case 'poke': {
                     elements.push({ type: 'poke', data: { type: i.poke_type, id: i.id } });
                     break;
                 }
+                case 'bubble_face': {
+                    elements.push({ type: 'bubble_face', data: { id: i.id, count: i.count } });
+                    break;
+                }
+                case 'contact': {
+                    elements.push({ type: 'contact', data: { type: i.scene, id: i.peer } });
+                    break;
+                }
+                case 'location': {
+                    elements.push({ type: 'location', data: { lat: i.lat, lon: i.lon, title: i.title, content: i.address } });
+                    break;
+                }
+                case 'long_msg':
+                case 'basketball':
+                case 'dice':
+                case 'market_face':
+                case 'rps': {
+                    elements.push({ type: i.type, data: { id: i.id } });
+                    break;
+                }
+                case 'gift': {
+                    elements.push({ type: 'gift', data: { qq: i.qq, id: i.id } });
+                    break;
+                }
+                case 'share': {
+                    elements.push({ type: 'share', data: { url: i.url, title: i.title, content: i.content, image: i.image } });
+                    break;
+                }
+                case 'weather': {
+                    elements.push({ type: 'weather', data: { city: i.city, type: i.type } });
+                    break;
+                }
                 default: {
                     elements.push(i);
-                    logger.info(i);
+                    break;
                 }
             }
         }
@@ -747,7 +774,14 @@ export class OneBot11 {
         }
         const { scene, peer } = contact;
         const message_type = scene === 'group' ? 'group_id' : 'user_id';
-        const messages = this.KarinConvertAdapter(elements);
+        const messages = [];
+        const selfUin = this.account.uin;
+        const selfNick = this.account.name;
+        for (const i of elements) {
+            const { type, user_id, nickname, content: contents } = i;
+            const content = this.KarinConvertAdapter(contents);
+            messages.push({ type, data: { uin: user_id || selfUin, name: nickname || selfNick, content } });
+        }
         const params = { [message_type]: String(peer), messages };
         return await this.SendApi('send_forward_msg', params);
     }
@@ -767,7 +801,7 @@ export class OneBot11 {
     }
     /**
      * 撤回消息
-     * @param {null} [_contact] - ob11无需提供contact参数
+     * @param _contact - ob11无需提供contact参数
      * @param message_id - 消息ID
      * @returns {Promise<null>}
      */
@@ -776,7 +810,7 @@ export class OneBot11 {
     }
     /**
      * 获取消息
-     * @param {null} [_contact] - ob11无需提供contact参数
+     * @param _contact - ob11无需提供contact参数
      * @param message_id - 消息ID
      * @returns {Promise<object>} - 消息内容
      */
@@ -988,22 +1022,8 @@ export class OneBot11 {
      * 获取群信息
      * @param group_id - 群号
      * @param no_cache - 是否不使用缓存
-     * @returns {Promise<IGroupInfo>} - 群信息
      */
     async GetGroupInfo(group_id, no_cache = false) {
-        /**
-         * @type {{
-         *   group_id: number,
-         *   group_name: string,
-         *   group_memo: string,
-         *   group_remark: string,
-         *   group_create_time: number,
-         *   group_level: number,
-         *   member_count: number,
-         *   max_member_count: number,
-         *   admins: number[]
-         * }}
-         */
         const groupInfo = await this.SendApi('get_group_info', { group_id, no_cache });
         return {
             group_id: groupInfo.group_id,

package/lib/core/index.d.ts

@@ -7,3 +7,4 @@ export * from './plugin.app.js';
 export * from './plugin.loader.js';
 export * from './process.js';
 export * from './server.js';
+import '../adapter/input/index.js';

package/lib/core/index.js

@@ -7,3 +7,4 @@ export * from './plugin.app.js'
 export * from './plugin.loader.js'
 export * from './process.js'
 export * from './server.js'
+import '../adapter/input/index.js'

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/listener.js

@@ -2,6 +2,8 @@ import { EventEmitter } from 'events'
 import { pluginLoader } from './plugin.loader.js'
 import { common, logger, config } from '../utils/index.js'
 import { MessageHandler } from '../event/message.handler.js'
+import NoticeHandler from '../event/notice.handler.js'
+import RequestHandler from '../event/request.handler.js'
 /**
  * 监听器管理
  */
@@ -33,11 +35,13 @@ class Listeners extends EventEmitter {
       this.addAdapter(data)
     })
     this.on('bot', data => {
-      this.addBot(data)
+      if (!this.addBot(data)) { return }
       logger.info(`[机器人][注册][${data.type}] ` + logger.green(`[account:${data.bot.account.uid || data.bot.account.uin}(${data.bot.account.name})]`))
       this.emit('karin:online', data.bot.account.uid || data.bot.account.uin)
     })
     this.on('message', data => new MessageHandler(data))
+    this.on('notice', data => new NoticeHandler(data))
+    this.on('request', data => new RequestHandler(data))
   }
 
   /**
@@ -47,7 +51,7 @@ class Listeners extends EventEmitter {
     this.index++
     const index = this.index
     if (!data.bot) {
-      logger.error('[Bot管理][注册] 注册失败: Bot实例不能为空')
+      logger.error('[Bot管理][注册] 注册失败: Bot实例不能为空', JSON.stringify(data))
       return false
     }
     this.list.push({ index, type: data.type, bot: data.bot })

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/core/server.js

@@ -76,6 +76,32 @@ export const server = new (class Server {
           process.exit()
         }
       })
+      /** 控制台适配器 */
+      this.app.get('/api/input', (req, res) => {
+        const name = req.query.name
+        const token = req.query.token
+        if (!name || !token) {
+          logger.error('[HTTP][input] 缺少参数', req.query)
+          return res.status(403).json({ error: '禁止访问', message: '缺少参数' })
+        }
+        // 禁止键入向上级目录
+        if (name.includes('/')) {
+          logger.error('[HTTP][input] 无效的文件名', name)
+          return res.status(403).json({ error: '禁止访问', message: '无效的文件名' })
+        }
+        const CfgToken = config.Config.AdapterInput.token
+        if (CfgToken === 'AdapterInput' || CfgToken !== token) {
+          logger.error('[HTTP][input] 无效的令牌', token)
+          return res.status(403).json({ error: '禁止访问', message: '无效的令牌' })
+        }
+        const file = process.cwd() + `/temp/input/${name}`
+        if (!fs.existsSync(file)) {
+          logger.error('[HTTP][input] 文件不存在', file)
+          return res.status(404).json({ error: '文件不存在', message: '找不到指定文件' })
+        }
+        logger.info(`${logger.yellow('[HTTP][input]')} ${logger.green(token)} file:${file}`)
+        res.sendFile(file)
+      })
       /** 监听端口 */
       const { host, port } = config.Server.http
       this.server.listen(port, host, () => {

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()