node-karin 0.10.0 → 0.10.2

package/lib/core/plugin/base.js

@@ -0,0 +1,140 @@
+/**
+ * 插件基类
+ */
+export class Plugin {
+    /**
+     * @param name - 插件名称
+     */
+    name;
+    /**
+     * @param dsc - 插件描述
+     * @deprecated 请使用desc
+     */
+    dsc;
+    /**
+     * @param desc - 插件描述
+     */
+    desc;
+    /**
+     * @param event - 监听事件
+     */
+    event;
+    /**
+     * @param priority - 优先级 默认10000
+     */
+    priority;
+    /**
+     * @param task - 定时任务
+     */
+    task;
+    /**
+     * @param rule - 命令规则
+     */
+    rule;
+    /**
+     * @param button - 按钮
+     */
+    button;
+    /**
+     * @param handler - handler
+     */
+    handler;
+    /**
+     * @param userId - 用户ID 一般上下文使用
+     */
+    userId;
+    /**
+     * @param timeout - 上下文超时
+     */
+    timeout;
+    constructor({ name, dsc = name, desc = name, event = "message" /* EventType.Message */, priority = 10000, task = [], rule = [], handler = [], button = [], }) {
+        this.name = name;
+        this.dsc = dsc;
+        this.desc = desc;
+        this.event = event;
+        this.priority = priority;
+        this.task = task;
+        this.rule = rule;
+        this.button = button;
+        this.handler = handler;
+    }
+    /**
+     * - 快速回复
+     */
+    reply(msg = '', options = { reply: false, recallMsg: 0, at: false, button: false, retry_count: 1 }) {
+        return this.e.reply(msg, options);
+    }
+    /**
+     * - 快速回复合并转发
+     */
+    async replyForward(msg) {
+        const result = await this.e.bot.sendForwardMessage(this.e.contact, msg);
+        return result;
+    }
+    /**
+     * - 构建上下文键
+     */
+    conKey() {
+        return `${this.e.isGroup ? `${this.e.group_id}.` : ''}` + (this.userId || this.e.user_id);
+    }
+    /**
+     * 设置上下文状态
+     */
+    setContext(
+    /**
+     * @param fnc - 执行方法
+     */
+    fnc, 
+    /**
+     * @param reply - 超时后是否回复
+     */
+    reply = true, 
+    /**
+     * @param time - 超时时间，默认120秒
+     */
+    time = 120) {
+        const key = this.conKey();
+        if (typeof fnc === 'string') {
+            stateArr[key] = { type: 'class', fnc: this, name: fnc };
+        }
+        else {
+            stateArr[key] = { type: 'fnc', fnc };
+        }
+        /** 操作时间 */
+        this.timeout = setTimeout(() => {
+            if (stateArr[key]) {
+                delete stateArr[key];
+                if (reply)
+                    this.e.reply('操作超时已取消', { at: true });
+            }
+        }, time * 1000);
+    }
+    /**
+     * 获取上下文状态
+     */
+    getContext() {
+        const key = this.conKey();
+        return stateArr[key];
+    }
+    /**
+     * 清除上下文状态
+     */
+    finish() {
+        const key = this.conKey();
+        if (stateArr[key] && stateArr[key]) {
+            /** 清除定时器 */
+            clearTimeout(this.timeout);
+            delete stateArr[key];
+        }
+    }
+    e;
+    replyCallback;
+}
+/**
+ * 上下文状态
+ */
+export const stateArr = {};
+/**
+ * @description 即将废弃，请使用 `Plugin`
+*/
+export const plugin = Plugin;

package/lib/core/{plugin.loader.d.ts → plugin/loader.d.ts}

@@ -1,7 +1,7 @@
 import chokidar from 'chokidar';
 import schedule from 'node-schedule';
-import { Plugin } from './plugin.js';
-import { PluginApps, PluginTask, dirName, fileName, AppInfo, NewMessagePlugin } from '../types/index.js';
+import { Plugin } from './base.js';
+import { PluginApps, PluginTask, dirName, fileName, AppInfo, NewMessagePlugin } from '../../types/index.js';
 declare class PluginLoader {
     dir: './plugins';
     dirPath: string;
@@ -103,7 +103,7 @@ declare class PluginLoader {
      */
     getApps(dir: dirName, isTs: boolean, isWatch?: boolean): void;
     /**
-     * 排序并打印插件加兹安信息
+     * 排序并打印插件信息
      * @param isPrint - 是否打印
      */
     orderBy(isPrint?: boolean): void;