node-karin 0.10.7 → 0.11.0

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

@@ -1,65 +1,27 @@
 import chokidar from 'chokidar';
-import schedule from 'node-schedule';
-import { Plugin } from './base.js';
-import { PluginApps, PluginTask, dirName, fileName, AppInfo, NewMessagePlugin } from '../../types/index.js';
+import { UseInfo, AppsType, TaskInfo, ButtonInfo, AcceptInfo, CommandInfo, HandlerInfo, PluginInfoType, PluginTaskInfoType, PluginButtonInfoType, PluginAcceptInfoType, PluginHandlerInfoType, PluginCommandInfoType, PluginMiddlewareInfoType } from '../../types/index.js';
+type AppType = CommandInfo | TaskInfo | HandlerInfo | ButtonInfo | AcceptInfo | UseInfo;
+export interface AppFile {
+    /** 插件包名称 */
+    plugin: string;
+    /** 插件apps相对路径 */
+    path: string;
+    /** 插件文件名称 */
+    file: string;
+    /** 插件类型 */
+    type: `${AppsType}`;
+    /** 热更新 */
+    isWatch: boolean;
+}
 declare class PluginLoader {
     dir: './plugins';
-    dirPath: string;
     /**
      * - 插件索引ID
      */
     index: number;
-    /**
-     * - 命令插件索引列表
-     */
-    ruleIds: Array<number>;
-    /**
-     * - 按钮插件索引列表
-     */
-    buttonIds: Array<number>;
-    /**
-     * - accept插件索引列表
-     */
-    acceptIds: Array<number>;
-    /**
-     * - handler
-     */
-    handlerIds: {
-        [key: string]: Array<{
-            index: string;
-            fnc: string | Function;
-            priority: number;
-        }>;
-    };
-    /**
-     * - 插件列表
-     */
-    FileList: Array<AppInfo>;
-    /**
-     * - 是否ts环境
-     */
-    isTs: boolean;
-    /**
-     * - 是否开发环境
-     */
-    isDev: boolean;
-    /**
-     * - 最终缓存的插件列表 通过index索引
-     */
-    PluginList: {
-        [key: string]: PluginApps;
-    };
     /**
      * - 定时任务
      */
-    task: Array<PluginTask & {
-        App: NewMessagePlugin;
-        schedule?: schedule.Job;
-        file: {
-            dir: dirName;
-            name: fileName;
-        };
-    }>;
     /**
      * - 监听器
      */
@@ -68,94 +30,109 @@ declare class PluginLoader {
      * - 热更新列表
      */
     watchList: Array<{
-        dir: dirName;
-        name?: fileName;
+        plugin: string;
+        path: string;
     }>;
-    /**
-     * - 所有插件包package.json
-     */
-    pkgJson: {
-        [key: string]: any;
-    };
     /**
      * - 依赖缺失收集
      */
     dependErr: {
         [key: string]: {
-            dir: dirName;
-            name: fileName;
+            plugin: string;
+            path: string;
+            file: string;
             depend: string;
         };
     };
+    /** accept */
+    accept: PluginAcceptInfoType[];
+    /** button */
+    button: PluginButtonInfoType[];
+    /** command规则集信息 */
+    command: PluginCommandInfoType[];
+    /** handler */
+    handler: {
+        [key: string]: PluginHandlerInfoType[];
+    };
+    /** plugin基本信息 */
+    plugin: PluginInfoType;
+    /** task定时任务信息 */
+    task: PluginTaskInfoType[];
+    /** 中间件 */
+    use: PluginMiddlewareInfoType;
+    /** 加载的文件数组 .js .ts */
+    ext: string[];
     constructor();
     /**
      * 插件初始化
      */
     load(): Promise<this>;
     /**
-     * 获取所有插件
+     * 获取Git插件
      */
-    getPlugins(): Promise<string[]>;
+    getGitPlugin(): Promise<Promise<boolean>[]>;
     /**
-     * 获取指定文件夹下的所有插件
-     * @param dir - 插件包名称
-     * @param isTs - 是否获取ts插件
-     */
-    getApps(dir: dirName, isTs: boolean, isWatch?: boolean): void;
-    /**
-     * 排序并打印插件信息
-     * @param isPrint - 是否打印
-     */
-    orderBy(isPrint?: boolean): void;
-    /**
-     * 新增插件
-     * @param dir - 插件包路径
-     * @param name - 插件名称
-     * @param isOrderBy - 是否为动态导入 默认为静态导入
-     * @param isNpm - 是否为npm包
-     * @param isMain - 是否为主入口文件
+     * 获取Npm插件
      */
-    createdApp(dir: dirName, name: fileName, isOrderBy?: boolean, isNpm?: boolean, isMain?: boolean): Promise<boolean>;
+    getNpmPlugin(): Promise<Promise<boolean>[]>;
     /**
-     * 打印依赖缺失
+     * 加载入口文件 只加载
+     * @param root - 插件根目录
+     * @param main - 入口文件
+     * @param isNpm - 是否为npm插件
      */
-    printDependErr(): void;
+    loadMain(root: string, main: string, isNpm: boolean): Promise<boolean>;
     /**
-     * 新增rule
+     * 获取ts插件入口 编译入口路径
+     * @param root - 插件根目录
+     * @param pkg - package.json
      */
-    addRule(dir: dirName, name: fileName, index: number, Class: Plugin): Promise<void>;
+    getTsMain(root: string, pkg: any): Promise<{
+        /** 编译产物入口 */
+        outDir: string;
+        /** ts源码入口 */
+        rootDir: string;
+    }>;
     /**
-     * 新增task fnc模式
+     * 加载指定文件夹下的所有插件
+     * @param plugin - 插件名称
+     * @param _path - 插件apps相对路径
+     * @param file - 插件文件名称
+     * @param isNpm - 是否为npm插件
+     * @param isWatch - 是否监听热更新
      */
-    addTaskFnc(dir: dirName, App: PluginApps): PluginTask[];
+    loadApps(plugin: string, _path: string, type: `${AppsType}`): Promise<boolean>[];
     /**
-     * 新增task
+     * 排序并打印插件信息
+     * @param isPrint - 是否打印
      */
-    addTask(dir: dirName, name: fileName, index: number, Class: Plugin, App: NewMessagePlugin): Promise<void>;
+    orderBy(isPrint?: boolean): void;
     /**
-     * 新增accept、handler
+     * 新增插件
+     * @param plugin - 插件名称 例如: karin-plugin-example
+     * @param _path - 插件路径 例如: lib/apps 不存在则传空字符串
+     * @param file - 插件文件 例如: index.js ts目前解释器支持不够，暂不支持ts
+     * @param type - 插件类型 默认为git
+     * @param isOrderBy - 是否排序 开启会使用动态导入
      */
-    addAccept(index: number, Class: Plugin): Promise<void>;
+    createdApp(plugin: string, _path: string, file: string, type?: `${AppsType}`, isOrderBy?: boolean): Promise<boolean>;
     /**
-     * 新增button
+     * 缓存插件
+     * @param index - 插件索引
      */
-    addButton(dir: dirName, name: fileName, index: number, Class: Plugin): Promise<void>;
+    cachePlugin(index: number, plugin: string, file: string, info: AppType, App?: any): Promise<boolean>;
     /**
-     * 执行初始化
+     * 打印依赖缺失
      */
-    addInit(Class: Plugin): Promise<void>;
+    printDependErr(): void;
     /**
      * 卸载插件
      */
-    uninstallApp(dir: dirName, name: fileName): void;
-    /**
-     * 监听单个文件热更新
-     */
-    watch(dir: dirName, name: fileName): void;
+    uninstallApp(plugin: string, _path: string, file: string): void;
     /**
      * 监听文件夹更新
      */
-    watchDir(dir: dirName): Promise<true | undefined>;
+    watchDir(plugin: string, _path: string): Promise<boolean>;
 }
 /**
  * 加载插件