node-karin 0.0.3

package/lib/core/plugin.js

@@ -0,0 +1,138 @@
+/**
+ * 插件基类
+ */
+export default class Plugin {
+  e
+  init
+  accept
+  replyCallback
+  /**
+     * @param name - 插件名称
+     */
+  name
+  /**
+     * @param dsc - 插件描述
+     * @deprecated 请使用desc
+     */
+  dsc
+  /**
+     * @param desc - 插件描述
+     */
+  desc
+  /**
+     * @param event - 监听事件
+     */
+  event
+  /**
+     * @param priority - 优先级 默认5000
+     */
+  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', priority = 5000, 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()
+    stateArr[key] = { plugin: this, 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]
+    }
+  }
+}
+/**
+ * 上下文状态
+ */
+export const stateArr = {}

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

@@ -0,0 +1,149 @@
+import path from 'path';
+import chokidar from 'chokidar';
+import schedule from 'node-schedule';
+import Plugin from './plugin.js';
+import { Plugin as PluginType, PluginApps, PluginTask, dirName, fileName, AppInfo } from '../types/plugin.js';
+/**
+ * 加载插件
+ */
+declare const _default: {
+    dir: './plugins';
+    dirPath: string;
+    /**
+     * - 插件列表
+     */
+    Apps: Array<PluginApps>;
+    /**
+     * - 定时任务
+     */
+    task: Array<PluginTask & {
+        App: new () => Plugin;
+        /**
+         * - 定时任务
+         */
+        schedule?: schedule.Job;
+        /**
+         * - 文件信息
+         */
+        file: {
+            dir: dirName;
+            name: fileName;
+        };
+    }>;
+    /**
+     * - 监听器
+     */
+    watcher: Map<string, chokidar.FSWatcher>;
+    /**
+     * - 热更新列表
+     */
+    watchList: Array<{
+        dir: dirName;
+        name?: fileName;
+    }>;
+    /**
+     * - 插件索引ID
+     */
+    index: number;
+    /**
+     * - 命令插件索引列表
+     */
+    rule: Array<number>;
+    PluginList: {
+        [key: string]: PluginApps;
+    };
+    /**
+     * 插件初始化
+     */
+    load(): Promise<any>;
+    /**
+     * 获取所有插件
+     */
+    getPlugins(): AppInfo[];
+    /**
+     * 获取指定文件夹下的所有插件
+     * @param dir - 插件包名称
+     * @param isTs - 是否获取ts插件
+     */
+    getApps(dir: dirName, isTs?: boolean): AppInfo[];
+    /**
+     * 构建插件信息
+     */
+    App(App: new () => Plugin, Class: PluginType, file: {
+        /**
+         * - 插件根目录名称
+         * - 例如: karin-plugin-example
+         * - 例如: karin-plugin-example/apps
+         */
+        dir: string;
+        /**
+         * - 插件名称
+         * - 例如: index.js
+         */
+        name: string;
+        /**
+         * - 插件相对路径
+         * - 从插件根目录开始
+         */
+        path: string;
+    }): {
+        App: new () => Plugin;
+        /** 插件文件信息 */
+        file: {
+            /**
+             * - 插件根目录名称
+             * - 例如: karin-plugin-example
+             * - 例如: karin-plugin-example/apps
+             */
+            dir: string;
+            /**
+             * - 插件名称
+             * - 例如: index.js
+             */
+            name: string;
+            /**
+             * - 插件相对路径
+             * - 从插件根目录开始
+             */
+            path: string;
+        };
+        name: string;
+        desc: string;
+        event: import("../types/index.js").Event | "message.group_message" | "message.friend_message" | "message.guild_message" | "message.nearby" | "message.stranger" | "message.stranger_from_group" | "message.friend_apply" | "message.group_apply" | "message.invited_group" | "message.friend_poke" | "message.friend_recall" | "message.friend_file_uploaded" | "message.group_poke" | "message.group_card_changed" | "message.group_member_unique_title_changed" | "message.group_essence_changed" | "message.group_recall" | "message.group_member_increase" | "message.group_member_decrease" | "message.group_admin_changed" | "message.group_member_ban" | "message.group_sign" | "message.group_whole_ban" | "message.group_file_uploaded" | "request.group_message" | "request.friend_message" | "request.guild_message" | "request.nearby" | "request.stranger" | "request.stranger_from_group" | "request.friend_apply" | "request.group_apply" | "request.invited_group" | "request.friend_poke" | "request.friend_recall" | "request.friend_file_uploaded" | "request.group_poke" | "request.group_card_changed" | "request.group_member_unique_title_changed" | "request.group_essence_changed" | "request.group_recall" | "request.group_member_increase" | "request.group_member_decrease" | "request.group_admin_changed" | "request.group_member_ban" | "request.group_sign" | "request.group_whole_ban" | "request.group_file_uploaded" | "notice.group_message" | "notice.friend_message" | "notice.guild_message" | "notice.nearby" | "notice.stranger" | "notice.stranger_from_group" | "notice.friend_apply" | "notice.group_apply" | "notice.invited_group" | "notice.friend_poke" | "notice.friend_recall" | "notice.friend_file_uploaded" | "notice.group_poke" | "notice.group_card_changed" | "notice.group_member_unique_title_changed" | "notice.group_essence_changed" | "notice.group_recall" | "notice.group_member_increase" | "notice.group_member_decrease" | "notice.group_admin_changed" | "notice.group_member_ban" | "notice.group_sign" | "notice.group_whole_ban" | "notice.group_file_uploaded" | "meta_event.group_message" | "meta_event.friend_message" | "meta_event.guild_message" | "meta_event.nearby" | "meta_event.stranger" | "meta_event.stranger_from_group" | "meta_event.friend_apply" | "meta_event.group_apply" | "meta_event.invited_group" | "meta_event.friend_poke" | "meta_event.friend_recall" | "meta_event.friend_file_uploaded" | "meta_event.group_poke" | "meta_event.group_card_changed" | "meta_event.group_member_unique_title_changed" | "meta_event.group_essence_changed" | "meta_event.group_recall" | "meta_event.group_member_increase" | "meta_event.group_member_decrease" | "meta_event.group_admin_changed" | "meta_event.group_member_ban" | "meta_event.group_sign" | "meta_event.group_whole_ban" | "meta_event.group_file_uploaded" | "message_sent.group_message" | "message_sent.friend_message" | "message_sent.guild_message" | "message_sent.nearby" | "message_sent.stranger" | "message_sent.stranger_from_group" | "message_sent.friend_apply" | "message_sent.group_apply" | "message_sent.invited_group" | "message_sent.friend_poke" | "message_sent.friend_recall" | "message_sent.friend_file_uploaded" | "message_sent.group_poke" | "message_sent.group_card_changed" | "message_sent.group_member_unique_title_changed" | "message_sent.group_essence_changed" | "message_sent.group_recall" | "message_sent.group_member_increase" | "message_sent.group_member_decrease" | "message_sent.group_admin_changed" | "message_sent.group_member_ban" | "message_sent.group_sign" | "message_sent.group_whole_ban" | "message_sent.group_file_uploaded";
+        priority: number;
+        accept: boolean;
+        rule: import("../types/plugin.js").PluginRule[];
+        type: "function" | "class";
+        task: PluginTask[];
+        handler: import("../types/plugin.js").PluginHandler[];
+        button: import("../types/plugin.js").PluginButton[];
+    };
+    /** 排序 */
+    orderBy(): void;
+    /**
+     * 新增插件
+     * @param dir - 插件包路径
+     * @param name - 插件名称
+     * @param isOrderBy - 是否重新导入
+     */
+    createdApp(dir: dirName, name: fileName, isOrderBy?: boolean): Promise<boolean>;
+    /**
+     * 卸载插件
+     */
+    uninstallApp(dir: dirName, name: fileName): void;
+    /** 创建定时任务 */
+    creatTask(): Promise<void>;
+    /**
+     * 卸载定时任务
+     */
+    uninstallTask(dir: dirName, name: fileName): void;
+    /**
+     * 监听单个文件热更新
+     */
+    watch(dir: dirName, name: fileName): void;
+    /**
+     * 监听文件夹更新
+     */
+    watchDir(dir: dirName): void;
+};
+export default _default;