@vtj/renderer 0.12.19 → 0.12.21

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@vtj/renderer",
   "private": false,
-  "version": "0.12.19",
+  "version": "0.12.21",
   "type": "module",
   "keywords": [
     "低代码引擎",
@@ -21,15 +21,15 @@
   "author": "chenhuachun",
   "license": "MIT",
   "dependencies": {
-    "@vtj/utils": "~0.12.19",
-    "@vtj/core": "~0.12.19"
+    "@vtj/core": "~0.12.21",
+    "@vtj/utils": "~0.12.21"
   },
   "devDependencies": {
     "vue": "~3.5.5",
     "vue-router": "~4.5.0",
     "@vtj/cli": "~0.12.2",
-    "@vtj/icons": "~0.12.19",
-    "@vtj/ui": "~0.12.19"
+    "@vtj/icons": "~0.12.21",
+    "@vtj/ui": "~0.12.21"
   },
   "exports": {
     ".": {

package/types/provider/enhance.d.ts

@@ -0,0 +1,15 @@
+import { EnhanceConfig } from '@vtj/core';
+import { App } from 'vue';
+import { Provider } from '../provider';
+/**
+ * 定义增强函数的返回类型
+ * 可以是一个接收Vue应用和Provider的函数，或者undefined
+ */
+export type LoadEnhanceReturn = ((app: App, provider: Provider) => void) | undefined;
+/**
+ * 异步加载增强配置
+ * @param config - 增强配置对象
+ * @param base - URL基础路径，默认为空字符串
+ * @returns 返回一个增强函数或undefined
+ */
+export declare function loadEnhance(config: EnhanceConfig, base?: string): Promise<LoadEnhanceReturn>;

package/types/provider/index.d.ts

@@ -1,3 +1,4 @@
 export * from './provider';
 export * from './apis';
 export * from './defaults';
+export * from './enhance';

package/types/provider/provider.d.ts

@@ -22,11 +22,19 @@ export interface ProviderOptions {
     routeAppendTo?: RouteRecordName;
     pageRouteName?: string;
     routeMeta?: RouteMeta;
+    enhance?: (app: App, provider: Provider) => void;
 }
 export declare enum NodeEnv {
     Production = "production",
     Development = "development"
 }
+/**
+ * Provider 类是应用的核心提供者，负责:
+ * - 管理项目配置和状态
+ * - 加载依赖和资源
+ * - 初始化路由
+ * - 提供全局API和服务
+ */
 export declare class Provider extends Base {
     options: ProviderOptions;
     mode: ContextMode;
@@ -44,27 +52,90 @@ export declare class Provider extends Base {
     private router;
     private materialPath;
     private urlDslCaches;
+    /**
+     * 创建Provider实例
+     * @param options 配置选项
+     */
     constructor(options: ProviderOptions);
     createMock(func: (...args: any) => any): (...args: any[]) => Promise<any>;
+    /**
+     * 加载项目配置并初始化
+     * 1. 从模块或服务加载项目配置
+     * 2. 根据运行模式加载依赖或资源
+     * 3. 初始化Mock数据
+     * 4. 创建API接口
+     * 5. 初始化路由(非uniapp平台)
+     * @param project 项目配置
+     */
     load(project: ProjectSchema): Promise<void>;
     initMock(global?: any): void;
     private loadDependencies;
     private loadAssets;
     private initRouter;
+    /**
+     * Vue 插件安装方法
+     * 1. 安装所有第三方库插件
+     * 2. 执行自定义安装函数(如果提供)
+     * 3. 安装访问适配器
+     * 4. 提供全局 Provider 实例
+     * 5. 设计模式下设置错误处理器
+     * 6. 执行增强函数(如果提供)
+     * @param app Vue 应用实例
+     */
     install(app: App): void;
     getFile(id: string): PageFile | BlockFile | null;
     getPage(id: string): PageFile | null;
     getHomepage(): PageFile | null;
     getDsl(id: string): Promise<BlockSchema | null>;
     getDslByUrl(url: string): Promise<BlockSchema | null>;
+    /**
+     * 创建 DSL 渲染器
+     * 1. 合并默认选项和自定义选项
+     * 2. 创建 DSL 加载器
+     * 3. 返回渲染器实例
+     * @param dsl 区块 DSL 配置
+     * @param opts 渲染选项
+     * @returns 渲染器实例
+     */
     createDslRenderer(dsl: BlockSchema, opts?: Partial<CreateRendererOptions>): {
         renderer: any;
         context: Context;
     };
+    /**
+     * 获取渲染组件
+     * 1. 根据ID查找文件(页面或区块)
+     * 2. 如果找到文件且提供了output回调，则调用它
+     * 3. 尝试从模块缓存加载原始Vue组件
+     * 4. 如果找不到原始组件，则获取DSL并创建渲染器
+     * @param id 文件ID
+     * @param output 找到文件时的回调函数
+     * @returns Promise<Vue组件>
+     */
     getRenderComponent(id: string, output?: (file: BlockFile | PageFile) => void): Promise<any>;
+    /**
+     * 定义基于URL的异步组件
+     * 1. 根据URL获取DSL配置
+     * 2. 如果获取成功，设置组件名称
+     * 3. 创建并返回DSL渲染器
+     * @param url DSL配置URL
+     * @param name 可选的自定义组件名称
+     * @returns Vue异步组件
+     */
     defineUrlSchemaComponent(url: string, name?: string): any;
+    /**
+     * 定义基于插件的异步组件
+     * 1. 根据插件来源获取插件实例
+     * 2. 返回插件组件
+     * @param from 插件来源配置
+     * @returns Vue异步组件
+     */
     definePluginComponent(from: NodeFromPlugin): any;
 }
+/**
+ * 创建 Provider 实例
+ * @param options Provider 配置选项
+ * @returns 包含 provider 实例和 onReady 回调的对象
+ */
 export declare function createProvider(options: ProviderOptions): {
     provider: Provider;
     onReady: (callback: () => void) => void;
@@ -73,4 +144,12 @@ export interface UseProviderOptions {
     id?: string;
     version?: string;
 }
+/**
+ * 在组件中使用 Provider 实例
+ * 1. 从Vue上下文中获取注入的Provider
+ * 2. 开发环境下检查组件版本一致性
+ * @param options 使用选项
+ * @returns Provider 实例
+ * @throws 如果找不到Provider会抛出错误
+ */
 export declare function useProvider(options?: UseProviderOptions): Provider;

package/types/utils/deps.d.ts

@@ -17,3 +17,7 @@ export declare function parseDeps(deps: Dependencie[], basePath: string, isDev?:
     libraryLocaleMap: Record<string, string>;
 };
 export declare function getRawComponent(desc: MaterialDescription, lib: any): any;
+export declare function parseUrls(urls?: string[]): {
+    css: string[];
+    js: string[];
+};

package/types/version.d.ts

@@ -2,7 +2,7 @@
  * Copyright (c) 2025, VTJ.PRO All rights reserved.
  * @name @vtj/renderer
  * @author CHC chenhuachun1549@dingtalk.com
- * @version 0.12.18
+ * @version 0.12.20
  * @license <a href="https://vtj.pro/license.html">MIT License</a>
  */
-export declare const version = "0.12.18";
+export declare const version = "0.12.20";