@yumerijs/core 1.1.3 → 1.2.1

package/dist/command.d.ts

@@ -1,5 +1,5 @@
 /**
- * @time: 2025/03/25 23:53
+ * @time: 2025/08/14 09:48
  * @author: FireGuo
  * WindyPear-Team All right reserved
  **/
@@ -52,6 +52,9 @@ export declare enum HttpMethod {
 /**
  * 命令类，用于注册和执行命令
  */
+/**
+ * @deprecated Use Route instead.
+ */
 export declare class Command {
     /** 命令名称 */
     name: string;

package/dist/command.js

@@ -1,6 +1,6 @@
 "use strict";
 /**
- * @time: 2025/03/25 23:53
+ * @time: 2025/08/14 09:48
  * @author: FireGuo
  * WindyPear-Team All right reserved
  **/
@@ -45,6 +45,9 @@ var HttpMethod;
 /**
  * 命令类，用于注册和执行命令
  */
+/**
+ * @deprecated Use Route instead.
+ */
 class Command {
     /** 命令名称 */
     name;

package/dist/context.d.ts

@@ -1,17 +1,97 @@
+/**
+ * @time: 2025/08/14 19:10
+ * @author: FireGuo
+ * WindyPear-Team All right reserved
+ **/
 import { Core } from './core';
 import { Command } from './command';
+import { Route } from './route';
+import { HookHandler } from './hook';
+/**
+ * 插件上下文对象
+ * 每个插件一个 Context，用于管理插件注册的命令、路由、事件、组件和中间件
+ */
 export declare class Context {
     private core;
+    private routes;
+    private eventlisteners;
+    private components;
+    private middlewares;
+    private hooks;
+    /**
+     * 插件名称
+     */
     pluginname: string;
+    /**
+     * 创建 Context 实例
+     * @param core Core 实例
+     * @param pluginname 插件名称
+     */
     constructor(core: Core, pluginname: string);
+    /**
+     * @deprecated Use route() instead.
+     * 尝试注册命令，如果命令已存在则警告
+     */
     command(name: string): Command;
+    /**
+     * 注册路由
+     * @param path 路由路径
+     * @returns Route 实例
+     */
+    route(path: string): Route;
+    /**
+     * 注册事件
+     * @param name 事件名称
+     * @param listener 事件监听器
+     */
     on(name: string, listener: (...args: any[]) => Promise<void>): void;
+    /**
+     * 注册全局中间件
+     * @param name 中间件名称
+     * @param callback 中间件回调函数
+     */
     use(name: string, callback: Function): void;
     /**
-     * Unless nessesary, do not use core directly
-    */
+     * 注册 Hook 钩子
+     * @param name Hook 点名称
+     * @param hookname 钩子名称
+     * @param callback 钩子回调函数
+     */
+    hook(name: string, hookname: string, callback: HookHandler): void;
+    /**
+     * 执行 Hook 钩子
+     * @param name Hook 点名称
+     * @param args Hook 参数
+     * @returns Promise<any[]>
+     */
+    executeHook(name: string, ...args: any[]): Promise<any[]>;
+    /**
+     * 获取 Core 实例
+     * @returns Core
+     */
     getCore(): Core;
+    /**
+     * 触发事件
+     * @param event 事件名称
+     * @param args 事件参数
+     * @returns Promise<void>
+     */
     emit(event: string, ...args: any[]): Promise<void>;
+    /**
+     * 获取组件实例
+     * @param name 组件名称
+     * @returns 组件实例
+     */
     getComponent(name: string): any;
+    /**
+     * 注册组件
+     * @param name 组件名称
+     * @param component 组件实例
+     */
     registerComponent(name: string, component: any): void;
+    /**
+     * 卸载插件时清理注册的所有资源
+     * 包括组件、路由、中间件和事件监听器
+     */
+    dispose(): void;
 }

package/dist/context.js

@@ -2,54 +2,166 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Context = void 0;
 const command_1 = require("./command");
+const route_1 = require("./route");
+/**
+ * 插件上下文对象
+ * 每个插件一个 Context，用于管理插件注册的命令、路由、事件、组件和中间件
+ */
 class Context {
     core;
+    routes = [];
+    eventlisteners = [];
+    components = [];
+    middlewares = [];
+    hooks = {};
+    /**
+     * 插件名称
+     */
     pluginname;
+    /**
+     * 创建 Context 实例
+     * @param core Core 实例
+     * @param pluginname 插件名称
+     */
     constructor(core, pluginname) {
         this.core = core;
         this.pluginname = pluginname;
     }
+    /**
+     * @deprecated Use route() instead.
+     * 尝试注册命令，如果命令已存在则警告
+     */
     command(name) {
         if (this.core.commands[name]) {
-            this.core.logger.warn(`Plugin "${this.pluginname}" attempt to register command "${name}", but it has been registered by plugin "${this.core.cmdtoplu[name]}."`);
+            this.core.logger.warn(`Plugin "${this.pluginname}" attempt to register command "${name}", but it has already been registered.`);
             return new command_1.Command(this.core, name);
         }
-        else {
-            this.core.cmdtoplu[name] = this.pluginname;
-            return this.core.command(name);
+        return this.core.command(name);
+    }
+    /**
+     * 注册路由
+     * @param path 路由路径
+     * @returns Route 实例
+     */
+    route(path) {
+        if (this.core.routes[path]) {
+            this.core.logger.warn(`Plugin "${this.pluginname}" attempt to register route "${path}", but it has already been registered.`);
+            return new route_1.Route(path);
         }
+        this.routes.push(path);
+        return this.core.route(path);
     }
+    /**
+     * 注册事件
+     * @param name 事件名称
+     * @param listener 事件监听器
+     */
     on(name, listener) {
-        // 存储该插件监听的事件，需要注意的是一个事件可由多个插件监听
-        this.core.evttoplu[name][this.pluginname].push(listener);
+        // 记录插件自己的事件监听器
+        this.eventlisteners.push({ name, listener });
+        // 注册到 core 的全局事件监听器中
         this.core.on(name, listener);
     }
+    /**
+     * 注册全局中间件
+     * @param name 中间件名称
+     * @param callback 中间件回调函数
+     */
     use(name, callback) {
-        this.core.mdwtoplu[name] = this.pluginname;
-        this.core.use(name, async (...args) => {
-            return callback(...args);
-        });
+        this.middlewares.push(name);
+        this.core.use(name, async (...args) => callback(...args));
+    }
+    /**
+     * 注册 Hook 钩子
+     * @param name Hook 点名称
+     * @param hookname 钩子名称
+     * @param callback 钩子回调函数
+     */
+    hook(name, hookname, callback) {
+        this.core.hook(name, hookname, callback);
+        this.hooks[name].push(hookname);
+    }
+    /**
+     * 执行 Hook 钩子
+     * @param name Hook 点名称
+     * @param args Hook 参数
+     * @returns Promise<any[]>
+     */
+    async executeHook(name, ...args) {
+        return await this.core.hookExecute(name, ...args);
     }
     /**
-     * Unless nessesary, do not use core directly
-    */
+     * 获取 Core 实例
+     * @returns Core
+     */
     getCore() {
         return this.core;
     }
+    /**
+     * 触发事件
+     * @param event 事件名称
+     * @param args 事件参数
+     * @returns Promise<void>
+     */
     async emit(event, ...args) {
         return await this.core.emit(event, ...args);
     }
+    /**
+     * 获取组件实例
+     * @param name 组件名称
+     * @returns 组件实例
+     */
     getComponent(name) {
         return this.core.getComponent(name);
     }
+    /**
+     * 注册组件
+     * @param name 组件名称
+     * @param component 组件实例
+     */
     registerComponent(name, component) {
         if (this.core.components[name]) {
-            this.core.logger.warn(`Plugin "${this.pluginname}" attempt to register component "${name}", but it has been registered by plugin "${this.core.comtoplu[name]}."`);
+            this.core.logger.warn(`Plugin "${this.pluginname}" attempt to register component "${name}", but it has already been registered.`);
             return;
         }
-        this.core.comtoplu[name] = this.pluginname;
         this.core.components[name] = component;
-        return;
+        this.components.push(name);
+    }
+    /**
+     * 卸载插件时清理注册的所有资源
+     * 包括组件、路由、中间件和事件监听器
+     */
+    dispose() {
+        // 删除组件
+        this.components.forEach((name) => {
+            delete this.core.components[name];
+        });
+        // 删除路由
+        this.routes.forEach((route) => {
+            delete this.core.routes[route];
+        });
+        // 删除中间件
+        this.middlewares.forEach((middleware) => {
+            delete this.core.globalMiddlewares[middleware];
+        });
+        // 删除事件监听器
+        this.eventlisteners.forEach(({ name, listener }) => {
+            if (this.core.eventListeners?.[name]) {
+                this.core.eventListeners[name] =
+                    this.core.eventListeners[name].filter((l) => l !== listener);
+            }
+        });
+        // 删除钩子
+        for (const hook in this.hooks) {
+            this.hooks.hook.forEach((hookname) => {
+                this.core.unhook(hook, hookname);
+            });
+        }
+        // 清空 Context 内部记录，避免内存泄漏
+        this.components = [];
+        this.routes = [];
+        this.middlewares = [];
+        this.eventlisteners = [];
     }
 }
 exports.Context = Context;

package/dist/core.d.ts

@@ -4,7 +4,9 @@ import { Command } from './command';
 import { Session } from './session';
 import { Platform } from './platform';
 import { Middleware } from './middleware';
+import { Route } from './route';
 import { Context } from './context';
+import { HookHandler, Hook } from './hook';
 interface Plugin {
     apply: (ctx: Context, config: Config) => Promise<void>;
     disable: (ctx: Context) => Promise<void>;
@@ -35,26 +37,38 @@ export declare class Core {
     };
     config: any;
     platforms: Platform[];
-    private eventListeners;
+    eventListeners: {
+        [event: string]: ((...args: any[]) => Promise<void>)[];
+    };
     components: {
         [name: string]: any;
     };
     commands: Record<string, Command>;
+    routes: Record<string, Route>;
     pluginLoader: PluginLoader;
     logger: Logger;
     providedComponents: {
         [name: string]: string;
     };
+    globalMiddlewares: Record<string, Middleware>;
+    pluginStatus: Record<string, PluginStatus>;
+    hooks: Record<string, Hook>;
+    private pluginWatchers;
     private pluginModules;
     private configPath;
-    private globalMiddlewares;
-    cmdtoplu: Record<string, string>;
-    comtoplu: Record<string, string>;
-    evttoplu: Record<string, Record<string, ((...args: any[]) => Promise<void>)[]>>;
-    mdwtoplu: Record<string, string>;
-    plftoplu: Record<string, string>;
-    pluginStatus: Record<string, PluginStatus>;
+    /**
+     * 插件名 -> Context 映射
+     */
+    private pluginContexts;
     constructor(pluginLoader: PluginLoader);
+    /**
+     * 获取或创建插件对应 Context
+     */
+    getContext(pluginName: string): Context;
+    /**
+     * 清理指定插件注册的所有内容
+     */
+    unregall(pluginName: string): void;
     /**
      * 加载配置文件
      * @param configPath 配置文件的路径
@@ -73,17 +87,19 @@ export declare class Core {
     getPluginConfig(pluginName: string): Promise<Config>;
     /**
      * 加载所有在配置文件中启用的插件
+     * @returns Promise<void>
      */
     loadPlugins(): Promise<void>;
     /**
-     * 导出的函数：加载单个插件
+     * 加载单个插件
      * @param pluginName 要加载的插件名
      * @param triggerPendingCheck 是否在加载后触发对其他待定插件的检查，默认为 true
      * @returns Promise<boolean> 是否加载成功
      */
     loadSinglePlugin(pluginName: string, triggerPendingCheck?: boolean, onlypending?: boolean): Promise<boolean>;
     /**
-     * 内部函数：尝试加载所有处于 PENDING 状态的插件
+     * 尝试加载所有处于 PENDING 状态的插件
+     * @returns Promise<void>
      */
     private _loadPendingPlugins;
     /**
@@ -92,8 +108,9 @@ export declare class Core {
      */
     unloadPlugin(pluginNameToUnload: string, ispending?: boolean): Promise<void>;
     /**
-     * 内部函数：执行单个插件的卸载逻辑
+     * 执行单个插件的卸载逻辑
      * @param pluginName 插件名
+     * @param ispending 是否处于 PENDING 状态
      */
     private _unloadSinglePlugin;
     /**
@@ -102,11 +119,11 @@ export declare class Core {
      */
     reloadPlugin(pluginName: string): Promise<void>;
     /**
-     * 监听插件文件变化，实现热更新
-     * @param core Core 实例
-     * @param pluginsDir 插件目录，默认为 'plugins'
+     * 监听插件文件变化
+     * @param pluginName 插件名称
+     * @param pluginPath 插件路径
      */
-    watchPlugins(core: Core, pluginsDir?: string): void;
+    private watchPlugin;
     /**
      * 注册组件
      * @param name 组件名称
@@ -144,35 +161,63 @@ export declare class Core {
      */
     use(name: string, middleware: Middleware): Core;
     /**
-     * 注册命令
-     * @param name 命令名称
-     * @returns Command 实例
+     * @deprecated 已更改为路由
      */
     command(name: string): Command;
+    /**
+     * 注册路由
+     * @param path 路由路径
+     * @returns Route 实例
+     */
+    route(path: string): Route;
+    /**
+     * 注册 Hook 钩子
+     * @param name Hook 点名称
+     * @param hookname 钩子名称
+     * @param callback 钩子函数
+     */
+    hook(name: string, hookname: string, callback: HookHandler): any;
+    /**
+     * 消除 Hook 钩子
+     */
+    unhook(name: string, hookname: string): any;
+    /**
+     * 执行 Hook 钩子
+     * @param name Hook 点名称
+     * @param args 参数
+     * @return Promise<any[]>
+     */
+    hookExecute(name: string, ...args: any[]): Promise<any[]>;
     /**
      * 执行命令
-     * @param name 命令名称
-     * @param session 会话对象
-     * @param args 传递给命令处理函数的参数
-     * @returns 会话对象或 null
+     * @deprecated
      */
     executeCommand(name: string, session: any, ...args: any[]): Promise<Session | null>;
+    /**
+     * 执行路由
+     * @param pathname 需要匹配的URL
+     * @param session 当前会话
+     * @param queryParams URL参数
+     * @returns 是否匹配成功
+     */
+    executeRoute(pathname: string, session: Session, queryParams: URLSearchParams): Promise<boolean>;
     /**
      * 注册平台
      * @param platform 平台实例
      * @returns 平台启动结果
      */
     registerPlatform(platform: Platform): any;
-    /**
-     * 清理指定插件注册的所有内容
-     * @param pluginname 插件名称
-     */
-    unregall(pluginname: string): void;
     /**
      * 获取命令
      * @param name 命令名称
      * @returns Command 实例或 null
      */
     getCommand(name: string): Command | null;
+    /**
+     * 获取路由
+     * @param path 匹配路径
+     * @return Route 实例或 false
+     */
+    getRoute(path: string): Route | false;
 }
 export {};