@yumerijs/core 1.1.2 → 1.2.0

package/dist/command.d.ts

@@ -52,6 +52,9 @@ export declare enum HttpMethod {
 /**
  * 命令类，用于注册和执行命令
  */
+/**
+ * @deprecated Use Route instead.
+ */
 export declare class Command {
     /** 命令名称 */
     name: string;

package/dist/command.js

@@ -45,6 +45,9 @@ var HttpMethod;
 /**
  * 命令类，用于注册和执行命令
  */
+/**
+ * @deprecated Use Route instead.
+ */
 class Command {
     /** 命令名称 */
     name;

package/dist/context.d.ts

@@ -1,17 +1,59 @@
 import { Core } from './core';
 import { Command } from './command';
+import { Route } from './route';
 export declare class Context {
     private core;
     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
     */
     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 组件实例
+     * @returns void
+     */
     registerComponent(name: string, component: any): void;
 }

package/dist/context.js

@@ -5,10 +5,18 @@ const command_1 = require("./command");
 class Context {
     core;
     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]}."`);
@@ -19,11 +27,42 @@ class Context {
             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 been registered by plugin "${this.core.routetoplu[path]}."`);
+            return this.core.routes[path];
+        }
+        else {
+            this.core.routetoplu[path] = this.pluginname;
+            return this.core.route(path);
+        }
+    }
+    /**
+     * 注册事件
+     * @param name 事件名称
+     * @param listener 事件监听器
+     */
     on(name, listener) {
         // 存储该插件监听的事件，需要注意的是一个事件可由多个插件监听
+        if (!this.core.evttoplu[name]) {
+            this.core.evttoplu[name] = {};
+        }
+        if (!this.core.evttoplu[name][this.pluginname]) {
+            this.core.evttoplu[name][this.pluginname] = [];
+        }
         this.core.evttoplu[name][this.pluginname].push(listener);
         this.core.on(name, listener);
     }
+    /**
+     * 注册全局中间件
+     * @param name 中间件名称
+     * @param callback 中间件回调函数
+     */
     use(name, callback) {
         this.core.mdwtoplu[name] = this.pluginname;
         this.core.use(name, async (...args) => {
@@ -36,12 +75,29 @@ class Context {
     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 组件实例
+     * @returns void
+     */
     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]}."`);

package/dist/core.d.ts

@@ -4,6 +4,7 @@ import { Command } from './command';
 import { Session } from './session';
 import { Platform } from './platform';
 import { Middleware } from './middleware';
+import { Route } from './route';
 import { Context } from './context';
 interface Plugin {
     apply: (ctx: Context, config: Config) => Promise<void>;
@@ -40,6 +41,7 @@ export declare class Core {
         [name: string]: any;
     };
     commands: Record<string, Command>;
+    routes: Record<string, Route>;
     pluginLoader: PluginLoader;
     logger: Logger;
     providedComponents: {
@@ -48,12 +50,39 @@ export declare class Core {
     private pluginModules;
     private configPath;
     private globalMiddlewares;
+    /**
+     * @deprecated 命令与插件对应关系
+     */
     cmdtoplu: Record<string, string>;
+    /**
+     * 路由与插件对应关系
+     */
+    routetoplu: 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>;
+    /**
+     * 插件监听器
+     */
+    private pluginWatchers;
+    /**
+     * 初始化核心
+     * @param pluginLoader 插件加载器
+     */
     constructor(pluginLoader: PluginLoader);
     /**
      * 加载配置文件
@@ -73,27 +102,30 @@ 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): Promise<boolean>;
+    loadSinglePlugin(pluginName: string, triggerPendingCheck?: boolean, onlypending?: boolean): Promise<boolean>;
     /**
-     * 内部函数：尝试加载所有处于 PENDING 状态的插件
+     * 尝试加载所有处于 PENDING 状态的插件
+     * @returns Promise<void>
      */
     private _loadPendingPlugins;
     /**
      * 卸载插件，并递归卸载依赖于它的其他插件
      * @param pluginNameToUnload 要卸载的插件名
      */
-    unloadPlugin(pluginNameToUnload: string): Promise<void>;
+    unloadPlugin(pluginNameToUnload: string, ispending?: boolean): Promise<void>;
     /**
-     * 内部函数：执行单个插件的卸载逻辑
+     * 执行单个插件的卸载逻辑
      * @param pluginName 插件名
+     * @param ispending 是否处于 PENDING 状态
      */
     private _unloadSinglePlugin;
     /**
@@ -102,11 +134,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,19 +176,28 @@ 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;
     /**
      * 执行命令
-     * @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 平台实例
@@ -174,5 +215,11 @@ export declare class Core {
      * @returns Command 实例或 null
      */
     getCommand(name: string): Command | null;
+    /**
+     * 获取路由
+     * @param path 匹配路径
+     * @return Route 实例或 false
+     */
+    getRoute(path: string): Route | false;
 }
 export {};