@pisell/core 1.0.15 → 1.0.17

package/es/applicationManager/application.d.ts

@@ -1,50 +1,202 @@
-import App from "../app";
-import { LoadLibraryByUrlParams } from "../locales/type";
-import { MenuItem } from "../menuManager/index";
+import App from '../app';
+import { LoadLibraryByUrlParams } from '../locales/type';
+import { MenuItem } from '../menuManager/index';
+/**
+ * 应用接口类型定义
+ * @description 描述应用中单个页面、组件或功能的接口结构
+ */
 export declare type ApplicationInterface = {
-    page_type: "low_code" | "code";
+    /** 页面类型：低代码或普通代码 */
+    page_type: 'low_code' | 'code';
+    /** 页面唯一标识 */
     page_id: number | string;
+    /** 页面code 优先使用 page_code  因为这个不会变， id在不同环境会变 */
     page_code: string;
+    /** 页面版本号，可选 */
     page_version?: string;
+    /** 页面显示名称， 这个会展示在tab标签页 */
     page_name: string;
-    router: string;
-    category: "page" | "component" | "function";
+    /** 路由地址, 可选 组件类型不使用这个 */
+    router?: string;
+    /** interface类别：页面、组件或功能 */
+    category: 'page' | 'component' | 'function';
+    /** React组件，可选， 不选使用低代码渲染 */
     Component?: any;
+    /** 子组件或子元素，可选， Layout会需要 */
     children?: any;
+    /** 布局模板，可选， 不选为默认layout */
     layout?: string;
+    /** 原始URL地址，可选 */
     originalUrl?: string;
+    autoRender?: boolean;
 };
+/**
+ * 应用数据类型定义
+ * @description 描述完整应用的数据结构，包含应用的基本信息、接口、功能等
+ */
 export declare type ApplicationData = {
+    /** 应用唯一标识 */
     app_id: number;
+    /** 应用名称 */
     app_name: string;
-    app_type: "system" | "custom";
+    /** 应用类型：系统应用或自定义应用 */
+    app_type: 'system' | 'custom';
+    /** 应用包含的接口列表 */
     interfaces: ApplicationInterface[];
+    /** 应用包含的功能列表，可选 */
     functions?: any[];
+    /** 应用的菜单配置 */
     menu?: {
         [key: string]: MenuItem[];
     };
+    /** 多语言配置，可选 */
     locales?: LoadLibraryByUrlParams;
+    /** 其他扩展属性 */
     [key: string]: any;
 };
+/**
+ * 应用管理类
+ * @description 负责管理单个应用的生命周期，包括接口、组件、功能的初始化和管理
+ * @class Application
+ * @author zhiwei.Wang
+ */
 export declare class Application {
+    /** 应用配置数据 */
     options: ApplicationData;
-    name: ApplicationData["app_name"];
-    interfaces: Map<ApplicationInterface["page_name"], ApplicationInterface>;
+    /** 应用名称 */
+    name: ApplicationData['app_name'];
+    /** 应用内的页面接口映射表，以页面名称为键 */
+    interfaces: Map<ApplicationInterface['page_name'], ApplicationInterface>;
+    /** 应用内的组件映射表，以组件编码为键 */
     components: Map<string, any>;
+    /** 应用内的功能函数映射表，比如跳转登录页面的方法等 */
     functions: Map<string, any>;
+    /** 应用实例引用 */
     app: App;
+    /**
+     * 构造函数
+     * @description 初始化应用实例，设置基本属性并初始化接口和功能
+     * @param {ApplicationData} options - 应用配置数据
+     * @param {App} app - 应用实例引用
+     */
     constructor(options: ApplicationData, app: App);
-    afterAdd(application: Application): Promise<void>;
-    beforeLoad(): Promise<void>;
-    load(): Promise<void>;
-    initInterfaces(interfaces: ApplicationData["interfaces"]): void;
-    initFunctions(functions: ApplicationData["functions"]): void;
+    /**
+     * 应用添加后的内部处理方法
+     * @description 在应用被添加到应用管理器后执行的内部逻辑，包括加载多语言配置和执行用户自定义的afterAdd方法
+     * @param {Application} application - 被添加的应用实例
+     * @returns {Promise<void>}
+     * @private
+     */
+    _afterAdd(application: Application): Promise<void>;
+    /**
+     * 应用加载前的内部处理方法
+     * @description 在应用开始加载前执行的内部逻辑，调用用户自定义的beforeLoad方法
+     * @returns {Promise<void>}
+     * @private
+     */
+    _beforeLoad(): Promise<void>;
+    /**
+     * 应用加载的内部处理方法
+     * @description 执行应用的实际加载逻辑，将应用中的所有接口注册为路由
+     * @returns {Promise<void>}
+     * @private
+     */
+    _load(): Promise<void>;
+    /**
+     * 初始化应用接口
+     * @description 遍历应用配置中的接口列表，根据类别将它们分别设置到对应的映射表中
+     * @param {ApplicationData['interfaces']} interfaces - 接口配置数组
+     * @returns {void}
+     */
+    initInterfaces(interfaces: ApplicationData['interfaces']): void;
+    /**
+     * 初始化应用功能函数
+     * @description 遍历应用配置中的功能列表，将它们设置到功能映射表中
+     * @param {ApplicationData['functions']} functions - 功能配置数组，可选
+     * @returns {void}
+     */
+    initFunctions(functions: ApplicationData['functions']): void;
+    /**
+     * 加载接口组件
+     * @description 根据接口类型加载对应的组件，支持低代码和普通代码两种类型
+     * @param {ApplicationInterface} interfaceItem - 接口配置项
+     * @returns {Promise<ApplicationInterface>} 加载后的接口配置
+     */
     loadInterface(interfaceItem: ApplicationInterface): Promise<ApplicationInterface>;
+    /**
+     * 设置页面
+     * @description 将页面接口添加到接口映射表中
+     * @param {string} code - 页面编码
+     * @param {ApplicationInterface} interfaceItem - 接口配置项
+     * @returns {void}
+     */
     setInterface(code: string, interfaceItem: ApplicationInterface): void;
+    /**
+     * 设置组件
+     * @description 将组件添加到组件映射表中
+     * @param {string} code - 组件编码
+     * @param {ApplicationInterface} component - 组件配置项
+     * @returns {void}
+     */
     setComponent(code: string, component: ApplicationInterface): void;
+    /**
+     * 设置功能函数
+     * @description 将功能函数添加到功能映射表中
+     * @param {string} code - 功能编码
+     * @param {ApplicationInterface} functionItem - 功能配置项
+     * @returns {void}
+     */
     setFunction(code: string, functionItem: ApplicationInterface): void;
+    /**
+     * 获取页面
+     * @description 根据编码从接口映射表中获取页面接口
+     * @param {string} code - 页面编码
+     * @returns {ApplicationInterface | undefined} 接口配置项或undefined
+     */
     getInterface(code: string): ApplicationInterface | undefined;
+    /**
+     * 获取组件
+     * @description 根据编码从组件映射表中获取组件
+     * @param {string} code - 组件编码
+     * @returns {any | undefined} 组件或undefined
+     */
     getComponent(code: string): any;
+    /**
+     * 获取功能函数
+     * @description 根据编码从功能映射表中获取功能函数
+     * @param {string} code - 功能编码
+     * @returns {any | undefined} 功能函数或undefined
+     */
     getFunction(code: string): any;
+    /**
+     * 执行功能函数
+     * @description 根据编码执行对应的功能函数，自动注入应用实例并合并参数
+     * @param {string} code - 功能编码
+     * @param {any} params - 传递给功能函数的参数对象，可选
+     * @param {...any} args - 传递给功能函数的其他参数
+     * @returns {any} 功能函数的执行结果
+     */
     runFunction(code: string, params?: any, ...args: any): any;
+    /**
+     * 应用添加后触发的钩子函数
+     * @description 在应用被添加到应用管理器后触发，可被子类覆盖以实现自定义逻辑
+     * @param {Application} application - 被添加的应用实例
+     * @returns {Promise<void>}
+     * @author zhiwei.Wang
+     */
+    afterAdd(application: Application): Promise<void>;
+    /**
+     * 应用加载前触发的钩子函数
+     * @description 在应用开始加载前触发，可被子类覆盖以实现自定义预处理逻辑
+     * @returns {Promise<void>}
+     * @author zhiwei.Wang
+     */
+    beforeLoad(application: Application): Promise<void>;
+    /**
+     * 应用加载完成后触发的钩子函数
+     * @description 在应用完成加载后触发，可被子类覆盖以实现自定义后处理逻辑
+     * @returns {Promise<void>}
+     * @author zhiwei.Wang
+     */
+    load(application: Application): Promise<void>;
 }