node-karin 0.6.11 → 0.6.13

package/lib/adapter/input/index.js

@@ -2,7 +2,7 @@ import fs from 'fs';
 import { randomUUID } from 'crypto';
 import { listener } from '../../core/index.js';
 import { KarinMessage } from '../../event/index.js';
-import { config, common, YamlEditor } from '../../utils/index.js';
+import { config, common, YamlEditor, logger } from '../../utils/index.js';
 const { enable, msgToFile, token: oldToken, ip } = config.Config.AdapterInput;
 /**
  * - 标准输入输出适配器

package/lib/adapter/onebot/onebot11.d.ts

@@ -153,17 +153,9 @@ export declare class AdapterOneBot11 implements KarinAdapter {
     SetGroupWholeBan(group_id: string, is_ban?: boolean): Promise<void>;
     /**
      * 设置群管理员
-     * @param {{
-     *  group_id:string,
-     *  target_uid?:string,
-     *  target_uin?:string,
-     *  is_admin:boolean
-     * }} options - 设置管理员选项
-     * @param options.group_id - 群组ID
-     * @param options.target_uid - 要设置为管理员的用户uid
-     * @param options.target_uin - 要设置为管理员的用户uin
-     * @param options.is_admin - 是否设置为管理员
-     * @returns {Promise<SetGroupAdminResponse>} - 设置群管理员操作的响应
+     * @param group_id - 群号
+     * @param target_uid_or_uin - 目标用户ID
+     * @param is_admin - 是否设置为管理员
      */
     SetGroupAdmin(group_id: string, target_uid_or_uin: string, is_admin: boolean): Promise<void>;
     /**

package/lib/adapter/onebot/onebot11.js

@@ -213,7 +213,7 @@ export class AdapterOneBot11 {
             uid: data.user_id + '',
             uin: data.user_id + '',
             nick: '',
-            role: '',
+            role: 'unknown',
         };
         const contact = {
             scene: ('group_id' in data ? 'group' : 'friend'),
@@ -223,8 +223,9 @@ export class AdapterOneBot11 {
         switch (data.notice_type) {
             // 群文件上传
             case 'group_upload': {
+                const group_id = data.group_id + '';
                 const content = {
-                    group_id: data.group_id + '',
+                    group_id,
                     operator_uid: data.user_id + '',
                     operator_uin: data.user_id + '',
                     file_id: data.file.id,
@@ -242,6 +243,7 @@ export class AdapterOneBot11 {
                     content,
                     sender,
                     contact,
+                    group_id,
                     sub_event: 'group_file_uploaded',
                 };
                 notice = new KarinNotice(options);
@@ -249,8 +251,9 @@ export class AdapterOneBot11 {
             }
             // 群管理员变动
             case 'group_admin': {
+                const group_id = data.group_id + '';
                 const content = {
-                    group_id: data.group_id + '',
+                    group_id,
                     target_uid: data.user_id + '',
                     target_uin: data.user_id + '',
                     is_admin: data.sub_type === 'set',
@@ -263,6 +266,7 @@ export class AdapterOneBot11 {
                     sender,
                     contact,
                     content,
+                    group_id,
                     sub_event: 'group_admin_changed',
                 };
                 notice = new KarinNotice(options);
@@ -270,10 +274,11 @@ export class AdapterOneBot11 {
             }
             // 群成员减少
             case 'group_decrease': {
+                const group_id = data.group_id + '';
                 const content = {
-                    group_id: data.group_id + '',
-                    operator_uid: data.operator_id || '',
-                    operator_uin: data.operator_id || '',
+                    group_id,
+                    operator_uid: (data.operator_id + '') || '',
+                    operator_uin: (data.operator_id + '') || '',
                     target_uid: data.user_id || '',
                     target_uin: data.user_id || '',
                     type: data.sub_type,
@@ -286,6 +291,7 @@ export class AdapterOneBot11 {
                     sender,
                     contact,
                     content,
+                    group_id,
                     sub_event: 'group_member_decrease',
                 };
                 notice = new KarinNotice(options);
@@ -293,8 +299,9 @@ export class AdapterOneBot11 {
             }
             // 群成员增加
             case 'group_increase': {
+                const group_id = data.group_id + '';
                 const content = {
-                    group_id: data.group_id + '',
+                    group_id,
                     operator_uid: (data.operator_id || '') + '',
                     operator_uin: (data.operator_id || '') + '',
                     target_uid: (data.user_id || '') + '',
@@ -309,6 +316,7 @@ export class AdapterOneBot11 {
                     sender,
                     contact,
                     content,
+                    group_id,
                     sub_event: 'group_member_increase',
                 };
                 notice = new KarinNotice(options);
@@ -316,10 +324,11 @@ export class AdapterOneBot11 {
             }
             // 群禁言事件
             case 'group_ban': {
+                const group_id = data.group_id + '';
                 const content = {
-                    group_id: data.group_id,
-                    operator_uid: data.operator_id || '',
-                    operator_uin: data.operator_id || '',
+                    group_id,
+                    operator_uid: (data.operator_id + '') || '',
+                    operator_uin: (data.operator_id + '') || '',
                     target_uid: data.user_id || '',
                     target_uin: data.user_id || '',
                     duration: data.duration,
@@ -333,6 +342,7 @@ export class AdapterOneBot11 {
                     sender,
                     contact,
                     content,
+                    group_id,
                     sub_event: 'group_member_ban',
                 };
                 notice = new KarinNotice(options);
@@ -343,10 +353,11 @@ export class AdapterOneBot11 {
                 this.logger('info', `[好友添加]：${JSON.stringify(data)}`);
                 break;
             case 'group_recall': {
+                const group_id = data.group_id + '';
                 const content = {
-                    group_id: data.group_id,
-                    operator_uid: data.operator_id || '',
-                    operator_uin: data.operator_id || '',
+                    group_id,
+                    operator_uid: (data.operator_id + '') || '',
+                    operator_uin: (data.operator_id + '') || '',
                     target_uid: data.user_id || '',
                     target_uin: data.user_id || '',
                     message_id: data.message_id,
@@ -360,6 +371,7 @@ export class AdapterOneBot11 {
                     sender,
                     contact,
                     content,
+                    group_id,
                     sub_event: 'group_recall',
                 };
                 notice = new KarinNotice(options);
@@ -388,8 +400,9 @@ export class AdapterOneBot11 {
             case 'notify':
                 switch (data.sub_type) {
                     case 'poke': {
+                        const group_id = 'group_id' in data ? data.group_id + '' : '';
                         const content = {
-                            group_id: data.group_id + '',
+                            group_id,
                             operator_uid: data.user_id + '',
                             operator_uin: data.user_id + '',
                             target_uid: data.target_id + '',
@@ -406,6 +419,7 @@ export class AdapterOneBot11 {
                             sender,
                             contact,
                             content,
+                            group_id,
                             sub_event: data.group_id ? 'group_poke' : 'private_poke',
                         };
                         notice = new KarinNotice(options);
@@ -422,8 +436,9 @@ export class AdapterOneBot11 {
                 }
                 break;
             case 'group_msg_emoji_like': {
+                const group_id = data.group_id + '';
                 const content = {
-                    group_id: data.group_id + '',
+                    group_id,
                     message_id: data.message_id,
                     face_id: data.likes[0].emoji_id,
                     is_set: true,
@@ -436,6 +451,7 @@ export class AdapterOneBot11 {
                     sender,
                     contact,
                     content,
+                    group_id,
                     sub_event: 'group_message_reaction',
                 };
                 notice = new KarinNotice(options);
@@ -465,7 +481,7 @@ export class AdapterOneBot11 {
                         uid: data.user_id + '',
                         uin: data.user_id + '',
                         nick: '',
-                        role: '',
+                        role: 'unknown',
                     },
                     sub_event: 'private_apply',
                     content: {
@@ -492,7 +508,7 @@ export class AdapterOneBot11 {
                         uid: data.user_id + '',
                         uin: data.user_id + '',
                         nick: '',
-                        role: '',
+                        role: 'unknown',
                     },
                     sub_event: data.sub_type === 'add' ? 'group_apply' : 'invited_group',
                     content: {
@@ -871,17 +887,9 @@ export class AdapterOneBot11 {
     }
     /**
      * 设置群管理员
-     * @param {{
-     *  group_id:string,
-     *  target_uid?:string,
-     *  target_uin?:string,
-     *  is_admin:boolean
-     * }} options - 设置管理员选项
-     * @param options.group_id - 群组ID
-     * @param options.target_uid - 要设置为管理员的用户uid
-     * @param options.target_uin - 要设置为管理员的用户uin
-     * @param options.is_admin - 是否设置为管理员
-     * @returns {Promise<SetGroupAdminResponse>} - 设置群管理员操作的响应
+     * @param group_id - 群号
+     * @param target_uid_or_uin - 目标用户ID
+     * @param is_admin - 是否设置为管理员
      */
     async SetGroupAdmin(group_id, target_uid_or_uin, is_admin) {
         const user_id = Number(target_uid_or_uin);

package/lib/core/karin.d.ts

@@ -119,5 +119,27 @@ export declare class Karin {
      * @param options - 渲染参数
      */
     render(options: KarinRenderType): Promise<string | string[]>;
+    /**
+     * - 上下文
+     * @param e - 消息事件
+     */
+    ctx(e: KarinMessage, options?: {
+        /**
+         * - 指定用户id触发下文 不指定则使用默认e.user_id
+         */
+        userId?: string;
+        /**
+         * - 超时时间 默认120秒
+         */
+        time?: number;
+        /**
+         * - 超时后是否回复
+         */
+        reply?: boolean;
+        /**
+         * - 超时回复文本 默认为'操作超时已取消'
+         */
+        replyMsg?: string;
+    }): Promise<KarinMessage>;
 }
 export {};

package/lib/core/karin.js

@@ -1,6 +1,8 @@
 import PluginApp from './plugin.app.js'
 import { common } from '../utils/index.js'
 import { render } from '../render/index.js'
+import { stateArr } from './plugin.js'
+import { listener } from './listener.js'
 export class Karin {
   /**
      * - 快速构建命令
@@ -117,4 +119,27 @@ export class Karin {
   render (options) {
     return render.render(options)
   }
+
+  /**
+     * - 上下文
+     * @param e - 消息事件
+     */
+  async ctx (e, options) {
+    const time = options?.time || 120
+    const userId = options?.userId || e.user_id
+    const key = e.group_id ? `${e.group_id}.${userId}` : userId
+    stateArr[key] = { type: 'ctx' }
+    // 返回promise 设置超时时间
+    return new Promise((resolve, reject) => {
+      setTimeout(() => {
+        if (stateArr[key]) {
+          delete stateArr[key]
+          if (options?.reply) { e.reply(options.replyMsg || '操作超时已取消') }
+          reject(new Error('操作超时已取消'))
+          return true
+        }
+      }, time * 1000)
+      listener.once(`ctx:${key}`, (e) => resolve(e))
+    })
+  }
 }

package/lib/core/listener.js

@@ -163,7 +163,7 @@ class Listeners extends EventEmitter {
     /** 标准化 */
     const NewElements = common.makeMessage(elements)
     /** 结果 */
-    let result = { message_id: '' }
+    let result = {}
     const reply_log = common.makeMessageLog(NewElements)
     const self_id = bot.account.uid || bot.account.uin
     if (contact.scene === 'group') {

package/lib/core/plugin.d.ts

@@ -1,4 +1,4 @@
-import { PluginType, KarinElement, KarinNodeElement, EventType, KarinNoticeEvent, KarinRequestEvent } from '../types/index.js';
+import { PluginType, KarinElement, KarinNodeElement, EventType, KarinNoticeEvent, KarinRequestEvent, stateArrType } from '../types/index.js';
 /**
  * 插件基类
  */
@@ -142,7 +142,7 @@ export declare class Plugin implements PluginType {
     /**
      * @param fnc - 执行方法
      */
-    fnc: string, 
+    fnc: string | Function, 
     /**
      * @param reply - 超时后是否回复
      */
@@ -154,10 +154,7 @@ export declare class Plugin implements PluginType {
     /**
      * 获取上下文状态
      */
-    getContext(): {
-        plugin: Plugin;
-        fnc: string;
-    };
+    getContext(): stateArrType[string];
     /**
      * 清除上下文状态
      */
@@ -166,18 +163,7 @@ export declare class Plugin implements PluginType {
 /**
  * 上下文状态
  */
-export declare const stateArr: {
-    [key: string]: {
-        /**
-         * @param plugin - 插件实例
-         */
-        plugin: Plugin;
-        /**
-         * @param fnc - 执行方法名称
-         */
-        fnc: string;
-    };
-};
+export declare const stateArr: stateArrType;
 /**
  * 通知事件 插件类型
  */

package/lib/core/plugin.js

@@ -103,7 +103,11 @@ export class Plugin {
      */
     time = 120) {
     const key = this.conKey()
-    stateArr[key] = { plugin: this, fnc }
+    if (typeof fnc === 'string') {
+      stateArr[key] = { type: 'class', fnc: this, name: fnc }
+    } else {
+      stateArr[key] = { type: 'fnc', fnc }
+    }
     /** 操作时间 */
     this.timeout = setTimeout(() => {
       if (stateArr[key]) {

package/lib/core/plugin.loader.js

@@ -123,14 +123,23 @@ class PluginLoader {
         this.getApps(dir, this.isTs, true)
         continue
       }
-      /** 入口文件 */
+      /** package */
+      const pack = common.readJson(`${PluginPath}/package.json`)
+      /** 旧版本入口文件 */
       const index = this.getIndex(PluginPath, process.env.karin_app_lang)
       if (index) {
         this.FileList.push({ dir, name: index })
         this.isDev && this.watchList.push({ dir, name: index })
       }
+      /** 新版本入口 */
+      if (pack.main) {
+        const { dir: dirName, pop } = common.splitPath(pack.main)
+        const dirPath = `${dir}/${dirName}`
+        this.FileList.push({ dir: dirPath, name: pop })
+        this.isDev && this.watchList.push({ dir: dirPath, name: pop })
+      }
       /** 检查是否存在karin.apps */
-      const pack = common.readJson(`${PluginPath}/package.json`)
+      const outDir = (pack?.karin?.outDir || 'dist')
       if (pack && pack?.karin?.apps) {
         const cfg = pack.karin.apps
         if (Array.isArray(cfg)) {
@@ -144,8 +153,8 @@ class PluginLoader {
       /** ts环境 全部加载  如果存在编译产物 则不加载ts */
       if (this.isTs) {
         /** 编译产物 存在不加载ts */
-        if (common.exists(`${PluginPath}/dist/apps`)) {
-          this.getApps((`${dir}/dist/apps`), false)
+        if (common.exists(`${PluginPath}/${outDir}/apps`)) {
+          this.getApps((`${dir}/${outDir}/apps`), false)
           continue
         }
         /** ts */
@@ -157,7 +166,7 @@ class PluginLoader {
       /** js环境 */
       if (common.isDir(`${PluginPath}/apps`)) { this.getApps(`${dir}/apps`, false) }
       /** 这里需要判断下 不然ts环境下会重复加载 */
-      if (!this.isTs && common.isDir(`${PluginPath}/dist/apps`)) { this.getApps(`${dir}/dist/apps`, false) }
+      if (!this.isTs && common.isDir(`${PluginPath}/${outDir}/apps`)) { this.getApps(`${dir}/${outDir}/apps`, false) }
     }
   }
 
@@ -247,6 +256,9 @@ class PluginLoader {
           if (!App?.name) { return logger.error(`[${dir}][${name}] 插件名称错误`) }
           App.file.dir = dir
           App.file.name = name
+          App.rule.forEach((v, index) => {
+            App.rule[index].log = v.log === false ? (id, log) => logger.bot('debug', id, log) : (id, log) => logger.bot('mark', id, log)
+          })
           /** handler */
           App.task = this.addTaskFnc(dir, App)
           this.PluginList[index] = App

package/lib/event/event.handler.js

@@ -16,7 +16,7 @@ export default class EventHandler {
     this.config = {}
     this.GroupMsgPrint = false
     /** 加入e.bot */
-    Object.defineProperty(this.e, 'bot', { value: listener.getBot(this.e.self_id) })
+    !this.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/message.handler.js

@@ -25,7 +25,6 @@ export class MessageHandler extends EventHandler {
       logger.debug('[消息拦截] 响应模式不匹配')
       return
     }
-    this.GroupMsgPrint = false
     /** 处理回复 */
     this.reply()
     /** 处理消息 */
@@ -51,8 +50,9 @@ export class MessageHandler extends EventHandler {
           if ('GroupCD' in this.config && !review.PluginEnable(app, this.config)) { continue }
           /** 判断子事件 */
           if (v.event && !this.filtEvent(v.event)) { continue }
-          this.e.logFnc = `[${app.file.dir}][${app.name}][${v.fnc}]`
-          const logFnc = logger.fnc(`[${app.name}][${v.fnc}]`)
+          const fncName = app.file.type === 'function' ? 'default' : v.fnc
+          this.e.logFnc = `[${app.file.dir}][${app.name}][${fncName}]`
+          const logFnc = logger.fnc(`[${app.name}][${fncName}]`)
           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 }
@@ -165,13 +165,15 @@ export class MessageHandler extends EventHandler {
           logs.push(`[json:${JSON.stringify(val.data)}]`)
           break
         case 'markdown': {
-          if (val.content) {
-            logs.push(`[markdown:${val.content}]`)
-          } else {
-            const content = { id: val.custom_template_id }
-            for (const v of val.params) { content[v.key] = v.values[0] }
-            logs.push(`[markdown:${JSON.stringify(content)}]`)
-          }
+          logs.push(`[markdown:${val.content}]`)
+          break
+        }
+        case 'markdown_tpl': {
+          const params = val.params
+          if (!params) { break }
+          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)}]`)
           break
         }
         case 'rows': {
@@ -219,14 +221,33 @@ export class MessageHandler extends EventHandler {
     const key = this.e.isGroup ? `${this.e.group_id}.${this.e.user_id}` : this.e.user_id
     const App = stateArr[key]
     if (App) {
-      const { plugin, fnc } = App
-      this.e.logFnc = `[${plugin.name}][${fnc}]`
-      /** 计算插件处理时间 */
-      const start = Date.now()
-      plugin.e = this.e
-      await plugin[fnc]()
-      logger.bot('mark', this.e.self_id, `${this.e.logFnc} 上下文处理完成 ${Date.now() - start}ms`)
-      return true
+      switch (App.type) {
+        case 'ctx': {
+          listener.emit(`ctx:${key}`, this.e)
+          delete stateArr[key]
+          return true
+        }
+        case 'class': {
+          const { fnc, name } = App
+          this.e.logFnc = `[${fnc.name}][${name}]`
+          /** 计算插件处理时间 */
+          const start = Date.now()
+          fnc.e = this.e
+          await fnc[name]()
+          logger.bot('mark', this.e.self_id, `${this.e.logFnc} 上下文处理完成 ${Date.now() - start}ms`)
+          return true
+        }
+        case 'fnc': {
+          const { fnc } = App
+          this.e.logFnc = `[${fnc.name}]`
+          /** 计算插件处理时间 */
+          const start = Date.now()
+          await fnc(this.e)
+          logger.bot('mark', this.e.self_id, `${this.e.logFnc} 上下文处理完成 ${Date.now() - start}ms`)
+          delete stateArr[key]
+          return true
+        }
+      }
     }
     return false
   }

package/lib/event/request.d.ts

@@ -1,5 +1,5 @@
 import { KarinEvent } from './event.js';
-import { contact, Sender, EventToSubEvent, RequestType, KarinRequestEvent } from '../types/index.js';
+import { contact, Sender, EventToSubEvent, RequestType } from '../types/index.js';
 /**
  * - 请求事件基类
  */
@@ -45,5 +45,5 @@ export declare class KarinRequest extends KarinEvent {
     /**
      * - 事件对应的内容参数
      */
-    content: KarinRequestEvent;
+    content: RequestType[EventToSubEvent['request']];
 }

package/lib/event/request.js

@@ -5,7 +5,6 @@ import { KarinEvent } from './event.js'
 export class KarinRequest extends KarinEvent {
   constructor ({ self_id, event_id, user_id, time, contact, sender, sub_event, content, group_id = '' }) {
     super({ event: 'request', event_id, self_id, user_id, group_id, time, contact, sender, sub_event })
-    // ...
     this.content = content
   }
 

package/lib/render/client.js

@@ -21,14 +21,14 @@ export class RenderClient extends RenderBase {
     this.index = 0
     this.retry = 0
     this.reg = new RegExp(`(${process.cwd().replace(/\\/g, '\\\\')}|${process.cwd().replace(/\\/g, '/')})`, 'g')
-    /** 连接ws */
-    this.ws = new WebSocket(this.url)
   }
 
   /**
      * 初始化
      */
   async start () {
+    /** 连接ws */
+    this.ws = new WebSocket(this.url)
     /** 建立连接 */
     this.ws.on('open', () => {
       logger.mark(`[渲染器:${this.id}][WebSocket] 建立连接：${logger.green(this.url)}`)

package/lib/types/adapter.d.ts

@@ -105,9 +105,10 @@ export interface KarinAdapter {
     /**
      * - 头像大小，默认需要为`0`，请开发者注意
      */
-    size?: number): string;
+    size?: 0 | 40 | 100 | 140): string;
     /**
-     * - 获取群头像
+     * 获取群头像url
+     * @returns 头像的url地址
      */
     getGroupAvatar(
     /**
@@ -117,7 +118,7 @@ export interface KarinAdapter {
     /**
      * - 头像大小，默认`0`
      */
-    size?: number, 
+    size?: 0 | 40 | 100 | 140, 
     /**
      * - 历史头像记录，默认`0`，若要获取历史群头像则填写1,2,3...
      */
@@ -141,7 +142,8 @@ export interface KarinAdapter {
         /**
          * - 消息ID
          */
-        message_id: string;
+        message_id?: string;
+        [key: string]: any;
     }>;
     /**
      * - 上传合并转发消息返回一个资源ID
@@ -193,7 +195,7 @@ export interface KarinAdapter {
     /**
      * - 消息ID
      */
-    message_id: string): Promise<void>;
+    message_id: string): Promise<void | boolean>;
     /**
      * - 获取消息
      */
@@ -281,7 +283,7 @@ export interface KarinAdapter {
     /**
      * - 赞的次数，默认为10
      */
-    vote_count: number): Promise<void>;
+    vote_count: number): Promise<void | boolean>;
     /**
      * - 群踢人
      */
@@ -554,7 +556,7 @@ export interface KarinAdapter {
         message_id?: string;
     }>;
     /**
-     * 对消息进行表情回应
+     * 对消息进行表情回应 icqq需要传递seq
      * @param Contact - 联系人信息
      * @param message_id - 消息ID
      * @param face_id - 表情ID

package/lib/types/element.d.ts

@@ -1,4 +1,4 @@
-export type ElementType = 'text' | 'at' | 'face' | 'bubble_face' | 'reply' | 'image' | 'voice' | 'video' | 'basketball' | 'dice' | 'rps' | 'poke' | 'music' | 'weather' | 'location' | 'share' | 'gift' | 'market_face' | 'forward' | 'contact' | 'json' | 'xml' | 'file' | 'markdown' | 'keyboard' | 'node' | 'rows' | 'record' | 'long_msg';
+export type ElementType = 'text' | 'at' | 'face' | 'bubble_face' | 'reply' | 'image' | 'voice' | 'video' | 'basketball' | 'dice' | 'rps' | 'poke' | 'music' | 'weather' | 'location' | 'share' | 'gift' | 'market_face' | 'forward' | 'contact' | 'json' | 'xml' | 'file' | 'markdown' | 'markdown_tpl' | 'keyboard' | 'node' | 'rows' | 'record' | 'long_msg';
 export interface Element {
     /**
      * - 元素类型
@@ -444,36 +444,18 @@ export interface ContentElement extends Element {
      * - 原生markdown内容
      */
     content: string;
+    config?: {
+        /** 未知的参数 */
+        unknown?: number;
+        time: number;
+        token: string;
+    };
 }
 /**
  * - 模板 Markdown 元素
  */
 export interface TemplateElement extends Element {
-    type: 'markdown';
-    /**
-     * - 模板ID
-     */
-    custom_template_id: string;
-    /**
-     * - 模板参数
-     */
-    params: Array<{
-        /**
-         * - 模板参数键名称
-         */
-        key: string;
-        /**
-         * - 模板参数值
-         */
-        values: Array<string>;
-    }>;
-}
-/**
- * - Markdown元素
- */
-export interface MarkdownElement extends Element {
-    type: 'markdown';
-    content: string;
+    type: 'markdown_tpl';
     /**
      * - 模板ID
      */
@@ -566,7 +548,7 @@ export interface LongMsgElement extends Element {
      */
     id: string;
 }
-export type KarinElement = TextElement | AtElement | FaceElement | BubbleFaceElement | ReplyElement | ImageElement | VoiceElement | VideoElement | BasketballElement | DiceElement | RpsElement | PokeElement | MusicElement | WeatherElement | LocationElement | ShareElement | GiftElement | MarketFaceElement | ForwardElement | ContactElement | JsonElement | XmlElement | FileElement | MarkdownElement | ButtonElement | RowElement | RecordElement | LongMsgElement;
+export type KarinElement = TextElement | AtElement | FaceElement | BubbleFaceElement | ReplyElement | ImageElement | VoiceElement | VideoElement | BasketballElement | DiceElement | RpsElement | PokeElement | MusicElement | WeatherElement | LocationElement | ShareElement | GiftElement | MarketFaceElement | ForwardElement | ContactElement | JsonElement | XmlElement | FileElement | ButtonElement | RowElement | RecordElement | LongMsgElement | TemplateElement | ContentElement;
 /**
  * - 构建自定义转发节点 此元素仅可通过专用接口发送 不支持混合发送
  */

package/lib/types/plugin.d.ts

@@ -1,6 +1,7 @@
 import schedule from 'node-schedule';
 import { Reply, replyCallback, replyForward } from './reply.js';
 import { EventType, Event, Permission, SubEvent, KarinMessageEvent, KarinNoticeEvent, KarinRequestEvent } from './event.js';
+import { Plugin } from '../core/index.js';
 /**
  * - 插件根目录名称
  * - 例如: karin-plugin-example
@@ -12,6 +13,21 @@ export type dirName = `karin-plugin-${string}`;
  * - 例如: index.js index.ts
  */
 export type fileName = `${string}.js` | `${string}.ts`;
+/**
+ * 上下文状态
+ */
+export interface stateArrType {
+    [key: string]: {
+        type: 'fnc';
+        fnc: Function;
+    } | {
+        type: 'class';
+        fnc: Plugin;
+        name: string;
+    } | {
+        type: 'ctx';
+    };
+}
 /**
  * - 插件规则
  */
@@ -198,30 +214,12 @@ export interface PluginType {
     /**
      * - 获取上下文状态
      */
-    getContext: () => {
-        /**
-         * - 插件实例
-         */
-        plugin: PluginType;
-        /**
-         * - 执行方法名称
-         */
-        fnc: string;
-    };
+    getContext: () => stateArrType[string];
     /**
      * - accept标准方法 给通知、请求事件使用
      */
     accept?(e: EventType<this>): Promise<void>;
 }
-/**
- * 上下文状态
- */
-export interface stateArrType {
-    [key: string]: {
-        plugin: PluginType;
-        fnc: string;
-    };
-}
 /**
  * - Apps
  */

package/lib/utils/common.d.ts

@@ -61,6 +61,18 @@ export declare const common: {
      * - 解析json文件
      */
     readJson(file: string): any;
+    /**
+     * - 写入json文件
+     */
+    writeJson(file: string, data: any): boolean;
+    /**
+     * - 解析yaml文件
+     */
+    readYaml(file: string): any;
+    /**
+     * - 写入yaml文件
+     */
+    writeYaml(file: string, data: any): boolean;
     /**
      * 根据文件后缀名从指定路径下读取符合要求的文件
      * @param path - 路径
@@ -70,10 +82,22 @@ export declare const common: {
      */
     readDir(_path: string, ext: string | string[]): string[] | null;
     /**
-     * 传入 import.meta.url 自动构建../
+     * 根据传入的 import.meta.url 计算相对于项目根目录的路径，返回需要的 '../' 层级。
      * @param url - import.meta.url
+     * @returns 相对路径的层级数量，用 '../' 表示
+     * @example
+     * // 在 plugins/karin-plugin-example/index.ts 中使用
+     * common.urlToPath(import.meta.url) // 返回 '../../'
      */
     urlToPath(url: string): string;
+    /**
+     * 传入相对路径 分割为两部分 1为文件夹路径 2为文件名 文件夹路径无前缀开头
+     * @param _path - 路径
+     */
+    splitPath(_path: string): {
+        dir: string;
+        pop: string;
+    };
     /**
      * 将文件转换为不带前缀的base64字符串
      * @param file - 文件路径或Buffer对象、可读流对象、http地址、base64://字符串
@@ -106,10 +130,9 @@ export declare const common: {
     makeMessage(elements: string | KarinElement | (string | KarinElement)[]): Array<KarinElement>;
     /**
      * 制作简单转发，返回segment.node[]。仅简单包装node，也可以自己组装
-     * @param {Array<{object}> | object} elements
+     * @param elements
      * @param fakeUin 用户id
      * @param fakeNick 用户昵称
-     * @return {Array<KarinNodeElement>}
      */
     makeForward(elements: KarinElement | KarinElement[], fakeUin: string, fakeNick: string): Array<KarinNodeElement>;
     /**

package/lib/utils/common.js

@@ -2,7 +2,7 @@ import { promisify } from 'util'
 import { fileURLToPath } from 'url'
 import { pipeline, Readable } from 'stream'
 import { logger, segment } from '../utils/index.js'
-import { fs, path, axios, lodash } from '../modules.js'
+import { fs, path, axios, lodash, yaml as Yaml } from '../modules.js'
 /**
  * 常用方法
  */
@@ -136,11 +136,49 @@ export const common = new (class Common {
     try {
       return JSON.parse(fs.readFileSync(file, 'utf8'))
     } catch (error) {
-      logger.error('读取json文件错误：' + error)
+      logger.error('[common] 读取json文件错误：' + error)
       return null
     }
   }
 
+  /**
+     * - 写入json文件
+     */
+  writeJson (file, data) {
+    try {
+      fs.writeFileSync(file, JSON.stringify(data, null, 2))
+      return true
+    } catch (error) {
+      logger.error('[common] 写入json文件错误：' + error)
+      return false
+    }
+  }
+
+  /**
+     * - 解析yaml文件
+     */
+  readYaml (file) {
+    try {
+      return Yaml.parse(fs.readFileSync(file, 'utf8'))
+    } catch (error) {
+      logger.error('[common] 读取yaml文件错误：' + error)
+      return null
+    }
+  }
+
+  /**
+     * - 写入yaml文件
+     */
+  writeYaml (file, data) {
+    try {
+      fs.writeFileSync(file, Yaml.stringify(data))
+      return true
+    } catch (error) {
+      logger.error('[common] 写入yaml文件错误：' + error)
+      return false
+    }
+  }
+
   /**
      * 根据文件后缀名从指定路径下读取符合要求的文件
      * @param path - 路径
@@ -162,25 +200,40 @@ export const common = new (class Common {
   }
 
   /**
-     * 传入 import.meta.url 自动构建../
+     * 根据传入的 import.meta.url 计算相对于项目根目录的路径，返回需要的 '../' 层级。
      * @param url - import.meta.url
+     * @returns 相对路径的层级数量，用 '../' 表示
+     * @example
+     * // 在 plugins/karin-plugin-example/index.ts 中使用
+     * common.urlToPath(import.meta.url) // 返回 '../../'
      */
   urlToPath (url) {
-    // 获取当前文件的绝对路径
+    /** 当前文件的绝对路径 */
     const filePath = fileURLToPath(url)
-    // 获取当前文件所在目录的绝对路径
+    /** 当前文件所在目录的绝对路径 */
     const dirPath = path.dirname(filePath)
-    // 获取项目根目录
+    /** 项目根目录 */
     const rootPath = process.cwd()
-    // 计算当前文件到项目根目录的相对路径
+    /** 当前文件到项目根目录的相对路径 */
     const relativePath = path.relative(dirPath, rootPath)
-    // 计算返回上一级目录的数量
+    /** 相对路径的层级数量 */
     const upLevelsCount = relativePath.split(path.sep).length
-    // 生成相应数量的 '../'
+    /** 返回构建的路径 */
     const upPath = lodash.repeat('../', upLevelsCount)
     return upPath
   }
 
+  /**
+     * 传入相对路径 分割为两部分 1为文件夹路径 2为文件名 文件夹路径无前缀开头
+     * @param _path - 路径
+     */
+  splitPath (_path) {
+    const list = _path.replace(/\\/g, '/').split('/')
+    const pop = list.pop() || ''
+    const dir = path.join(...list)
+    return { dir, pop }
+  }
+
   /**
      * 将文件转换为不带前缀的base64字符串
      * @param file - 文件路径或Buffer对象、可读流对象、http地址、base64://字符串
@@ -297,10 +350,9 @@ export const common = new (class Common {
 
   /**
      * 制作简单转发，返回segment.node[]。仅简单包装node，也可以自己组装
-     * @param {Array<{object}> | object} elements
+     * @param elements
      * @param fakeUin 用户id
      * @param fakeNick 用户昵称
-     * @return {Array<KarinNodeElement>}
      */
   makeForward (elements, fakeUin, fakeNick) {
     if (!Array.isArray(elements)) { elements = [elements] }
@@ -406,13 +458,15 @@ export const common = new (class Common {
           logs.push(`[json:${val.data}]`)
           break
         case 'markdown': {
-          if (val.content) {
-            logs.push(`[markdown:${val.content}]`)
-          } else {
-            const content = { id: val.custom_template_id }
-            for (const v of val.params) { content[v.key] = v.values[0] }
-            logs.push(`[markdown:${JSON.stringify(content)}]`)
-          }
+          logs.push(`[markdown:${val.content}]`)
+          break
+        }
+        case 'markdown_tpl': {
+          const params = val.params
+          if (!params) { break }
+          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)}]`)
           break
         }
         case 'rows': {

package/lib/utils/segment.d.ts

@@ -1,4 +1,4 @@
-import { TextElement, AtElement, ImageElement, FaceElement, BubbleFaceElement, ReplyElement, VoiceElement, VideoElement, BasketballElement, DiceElement, RpsElement, PokeElement, MusicElement, WeatherElement, LocationElement, ShareElement, GiftElement, MarketFaceElement, ForwardElement, ContactElement, JsonElement, XmlElement, FileElement, ButtonElement, CustomMusicElemen, TemplateElement, ContentElement, KarinNodeElement, KarinElement } from '../types/index.js';
+import { TextElement, AtElement, ImageElement, FaceElement, BubbleFaceElement, ReplyElement, VoiceElement, VideoElement, BasketballElement, DiceElement, RpsElement, PokeElement, MusicElement, WeatherElement, LocationElement, ShareElement, GiftElement, MarketFaceElement, ForwardElement, ContactElement, JsonElement, XmlElement, FileElement, ButtonElement, CustomMusicElemen, TemplateElement, ContentElement, KarinNodeElement, KarinElement, LongMsgElement } from '../types/index.js';
 export declare const segment: {
     /**
      * 纯文本
@@ -78,7 +78,7 @@ export declare const segment: {
      */
     record(file: string, magic?: boolean, md5?: string, name?: string): VoiceElement;
     /**
-     * 语音
+     * 语音 即将废弃 请使用segment.record
      * @param file - 语音URL或路径、Base64
      * @param magic - 是否魔法语音，默认为 false
      * @param md5 - 语音md5
@@ -241,21 +241,23 @@ export declare const segment: {
          */
         md5?: string;
     }): FileElement;
+    /**
+     * 长消息
+     * @param id - ID
+     */
+    long_msg(id: string): LongMsgElement;
     /**
      * Markdown
      * @param content - 原生markdown内容
-     * @returns {ContentElement} Markdown元素
+     * @param config - 未知的参数
      */
-    markdown(content: string, params?: Array<{
-        /**
-         * - 模板参数键名称
-         */
-        key: string;
-        /**
-         * - 模板参数值
-         */
-        values: Array<string>;
-    }>): ContentElement | TemplateElement;
+    markdown(content: ContentElement["content"], config?: ContentElement["config"]): ContentElement;
+    /**
+     * 构建模板Markdown
+     * @param custom_template_id - 模板ID
+     * @param params - 模板markdown参数
+     */
+    markdown_tpl(custom_template_id: TemplateElement["custom_template_id"], params: TemplateElement["params"]): TemplateElement;
     /**
      * 按钮
      * @param data - 按钮数据

package/lib/utils/segment.js

@@ -112,7 +112,7 @@ export const segment = new (class Segment {
   }
 
   /**
-     * 语音
+     * 语音 即将废弃 请使用segment.record
      * @param file - 语音URL或路径、Base64
      * @param magic - 是否魔法语音，默认为 false
      * @param md5 - 语音md5
@@ -384,29 +384,47 @@ export const segment = new (class Segment {
     }
   }
 
+  /**
+     * 长消息
+     * @param id - ID
+     */
+  long_msg (id) {
+    return {
+      type: 'long_msg',
+      id,
+    }
+  }
+
   /**
      * Markdown
      * @param content - 原生markdown内容
-     * @returns {ContentElement} Markdown元素
+     * @param config - 未知的参数
      */
-  markdown (
+  markdown (content, config) {
+    return {
+      type: 'markdown',
+      content,
+      config,
+    }
+  }
+
+  /**
+     * 构建模板Markdown
+     * @param custom_template_id - 模板ID
+     * @param params - 模板markdown参数
+     */
+  markdown_tpl (
     /**
-     * - 原生markdown内容 或 模板ID
+     * - 模板ID
      */
-    content,
+    custom_template_id,
     /**
-     * - 模板markdown参数 原生markdown内容时无效
-     */
-    params = []) {
-    if (typeof content === 'string') {
-      return {
-        type: 'markdown',
-        content,
-      }
-    }
+     * - 模板markdown参数
+     */
+    params) {
     return {
-      type: 'markdown',
-      custom_template_id: content,
+      type: 'markdown_tpl',
+      custom_template_id,
       params,
     }
   }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "node-karin",
-  "version": "0.6.11",
+  "version": "0.6.13",
   "private": false,
   "description": "基于 Kritor 进行开发的nodejs机器人框架",
   "homepage": "https://github.com/KarinJS/Karin",
@@ -58,7 +58,6 @@
   "dependencies": {
     "@grpc/grpc-js": "1.10.10",
     "@grpc/proto-loader": "0.7.13",
-    "@inquirer/prompts": "^5.0.7",
     "art-template": "4.13.2",
     "axios": "1.7.2",
     "chalk": "5.3.0",