node-karin 0.6.11 → 0.6.12

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/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/event/message.handler.js

@@ -219,14 +219,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/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/package.json

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