@next-bricks/visual-builder 1.39.16 → 1.39.18

package/dist/types.json

@@ -1074,7 +1074,7 @@
           "type": "reference",
           "typeName": {
             "type": "identifier",
-            "name": "UseBrickConf"
+            "name": "UseBrickConfOrRenderFunction"
           }
         }
       },
@@ -1862,7 +1862,7 @@
         "name": "open",
         "params": [
           {
-            "name": "param_1",
+            "name": "openInfo",
             "annotation": {
               "type": "reference",
               "typeName": {
@@ -2202,6 +2202,28 @@
       }
     ]
   },
+  "visual-builder.inject-chat-preview-agent": {
+    "type": "provider",
+    "params": [],
+    "returns": {
+      "annotation": {
+        "type": "reference",
+        "typeName": {
+          "type": "identifier",
+          "name": "Promise"
+        },
+        "typeParameters": {
+          "type": "typeParameterInstantiation",
+          "params": [
+            {
+              "type": "keyword",
+              "value": "unknown"
+            }
+          ]
+        }
+      }
+    }
+  },
   "visual-builder.get-config-by-data-for-ai": {
     "type": "provider",
     "params": [
@@ -2630,28 +2652,6 @@
       }
     ]
   },
-  "visual-builder.inject-chat-preview-agent": {
-    "type": "provider",
-    "params": [],
-    "returns": {
-      "annotation": {
-        "type": "reference",
-        "typeName": {
-          "type": "identifier",
-          "name": "Promise"
-        },
-        "typeParameters": {
-          "type": "typeParameterInstantiation",
-          "params": [
-            {
-              "type": "keyword",
-              "value": "unknown"
-            }
-          ]
-        }
-      }
-    }
-  },
   "visual-builder.workbench-history-action": {
     "properties": [
       {
@@ -2834,26 +2834,11 @@
                 "name": "useBrick"
               },
               "annotation": {
-                "type": "union",
-                "types": [
-                  {
-                    "type": "reference",
-                    "typeName": {
-                      "type": "identifier",
-                      "name": "UseSingleBrickConf"
-                    }
-                  },
-                  {
-                    "type": "array",
-                    "elementType": {
-                      "type": "reference",
-                      "typeName": {
-                        "type": "identifier",
-                        "name": "UseSingleBrickConf"
-                      }
-                    }
-                  }
-                ]
+                "type": "reference",
+                "typeName": {
+                  "type": "identifier",
+                  "name": "UseBrickConfOrRenderFunction"
+                }
               },
               "computed": false
             }

package/dist-types/chat-conversation/index.d.ts

@@ -14,11 +14,17 @@ export interface ChatConversationProps {
     errorBoundary?: boolean;
 }
 /**
- * 用于 Visual Builder 的智能聊天对话列表
+ * 用于 Visual Builder 的智能聊天对话列表，解析 AI 回复中的 Storyboard 代码块并触发更新事件
  */
 export declare class ChatConversation extends ReactNextElement implements ChatConversationProps {
     #private;
+    /**
+     * 对话消息列表，包含用户和 AI 助手的消息，支持流式（partial）和失败（failed）状态
+     */
     accessor messages: Message[] | undefined;
+    /**
+     * 是否为解析出的砖块启用错误边界，防止单个砖块异常导致整个预览崩溃
+     */
     accessor errorBoundary: boolean | undefined;
     render(): React.JSX.Element;
 }

package/dist-types/chat-preview/index.d.ts

@@ -11,15 +11,34 @@ export interface ChatPreviewProps {
     inspecting?: boolean;
 }
 /**
- * 构件 `visual-builder.chat-preview`
+ * Visual Builder 的聊天预览构件，在 iframe 中渲染 Storyboard 并支持元素检查模式
  */
 export declare class ChatPreview extends ReactNextElement {
     #private;
+    /**
+     * 要预览的砖块配置，支持单个或列表，更新后自动触发 iframe 重新渲染
+     */
     accessor storyboard: BrickConf | BrickConf[] | undefined;
+    /**
+     * 预览的主题，例如 "dark-v2"
+     */
     accessor theme: string | undefined;
+    /**
+     * 预览的 UI 版本，例如 "8.2"
+     */
     accessor uiVersion: string | undefined;
+    /**
+     * 预览使用的 MicroApp 配置，影响 app 上下文
+     */
     accessor app: MicroApp | undefined;
+    /**
+     * 是否开启元素检查模式，开启后鼠标悬停和点击时会显示元素轮廓高亮
+     */
     accessor inspecting: boolean | undefined;
+    /**
+     * 向 iframe 内的预览代理发送选中指令，高亮指定元素
+     * @param payload 要选中的元素选择器
+     */
     select(payload: InspectSelector): void;
     render(): React.JSX.Element;
 }

package/dist-types/contract-select/index.d.ts

@@ -1,18 +1,33 @@
 import React from "react";
+import { UseBrickConfOrRenderFunction } from "@next-core/react-runtime";
 import "@next-core/theme";
 import { FormItemElementBase } from "@next-shared/form";
-import { UseSingleBrickConf } from "@next-core/types";
 /**
- * 契约选择构件
+ * 契约选择构件，提供契约名称和版本的联动选择，格式为 `contractName@namespace:version`，支持在表单中使用
  */
 export declare class EoContractSelect extends FormItemElementBase {
     #private;
+    /**
+     * 表单字段名
+     */
     accessor name: string | undefined;
+    /**
+     * 是否为必填项
+     */
     accessor required: boolean | undefined;
+    /**
+     * 表单项标签
+     */
     accessor label: string | undefined;
+    /**
+     * 当前选中的契约值，格式为 `contractName@namespace:version`
+     */
     accessor value: any | undefined;
+    /**
+     * 输入框后缀内容，使用 useBrick 自定义渲染
+     */
     accessor suffix: {
-        useBrick: UseSingleBrickConf | UseSingleBrickConf[];
+        useBrick: UseBrickConfOrRenderFunction;
     } | undefined;
     handleChange: (v: string) => void;
     render(): React.JSX.Element;
@@ -23,7 +38,7 @@ export interface EoContractSelectProps {
     placeholder?: string;
     inputStyle?: React.CSSProperties;
     suffix?: {
-        useBrick: UseSingleBrickConf | UseSingleBrickConf[];
+        useBrick: UseBrickConfOrRenderFunction;
     };
     onChange?(value: string): void;
 }

package/dist-types/generate-snippets-context-menu/index.d.ts

@@ -25,14 +25,30 @@ export interface SnippetOption {
     children?: SnippetItem[];
 }
 /**
- * 构件 `visual-builder.generate-snippets-context-menu`
+ * 用于 Visual Builder 的代码片段右键上下文菜单，支持拖拽片段到画布，菜单位置自动适配视口边界
  */
 export declare class GenerateSnippetsContextMenu extends ReactNextElement {
     #private;
+    /**
+     * 菜单选项列表，每组包含标题和子菜单项
+     */
     accessor options: SnippetOption[] | undefined;
+    /**
+     * 菜单是否处于激活（显示）状态，通过 open/close 方法控制
+     */
     accessor active: boolean | undefined;
+    /**
+     * 菜单显示位置，格式为 `[clientX, clientY]`，超出视口时自动修正
+     */
     accessor position: Position | undefined;
+    /**
+     * 打开上下文菜单并定位到指定位置
+     * @param openInfo 包含菜单位置的配置，position 通常设为 `[EVENT.clientX, EVENT.clientY]`
+     */
     open({ position }: OpenInfo): void;
+    /**
+     * 关闭上下文菜单
+     */
     close(): void;
     disconnectedCallback(): void;
     render(): React.JSX.Element;

package/dist-types/page-arch-node/index.d.ts

@@ -24,17 +24,41 @@ export interface ContextMenuDetail {
 }
 export type PageArchNodeType = "page" | "board";
 /**
- * 构件 `visual-builder.page-arch-node`
+ * Visual Builder 页面架构图节点，支持页面（page）和看板（board）两种类型，可内联编辑标签、追加子节点、显示外链和子节点
  */
 export declare class PageArchNode extends ReactNextElement implements PageArchNodeProps {
     #private;
+    /**
+     * 节点标签文字，支持内联双击编辑
+     */
     accessor label: string | undefined;
+    /**
+     * 节点类型，"page" 渲染为页面缩略图样式（高 130px），"board" 渲染为列表图标样式（高 70px）
+     */
     accessor type: PageArchNodeType | undefined;
+    /**
+     * 外部链接节点数据，仅 type="page" 时显示，点击触发 external.click 事件
+     */
     accessor external: ExtraNodeData | undefined;
+    /**
+     * 子节点列表，仅 type="page" 时显示，每个子节点可双击和右键操作
+     */
     accessor subNodes: ExtraNodeData[] | undefined;
+    /**
+     * 是否为当前激活节点，仅控制 CSS 样式（render: false），不触发重新渲染
+     */
     accessor active: boolean | undefined;
+    /**
+     * 是否标记为未同步状态，仅控制 CSS 样式（render: false），不触发重新渲染
+     */
     accessor notSynced: boolean | undefined;
+    /**
+     * 是否禁用追加子节点按钮，仅控制 CSS 样式（render: false），不触发重新渲染
+     */
     accessor disableChildAppend: boolean | undefined;
+    /**
+     * 自动聚焦标识符，设置后节点首次挂载时会自动进入标签编辑模式，同一标识符只触发一次
+     */
     accessor autoFocusOnce: string | undefined;
     render(): React.JSX.Element;
 }

package/dist-types/pre-generated-config/i18n.d.ts

@@ -5,7 +5,7 @@ export declare const locales: {
     en: Locale;
     zh: Locale;
 };
-export declare const t: any;
+export declare const t: import("i18next").TFunction<"bricks/visual-builder/pre-generated-config", string, "bricks/visual-builder/pre-generated-config">;
 type Locale = {
     [k in K]: string;
 } & {

package/dist-types/pre-generated-config/index.d.ts

@@ -57,14 +57,29 @@ export interface ContainerConfig {
     };
 }
 /**
- * 构件 `visual-builder.pre-generated-config`
+ * AI 预生成配置选择器，以 iframe 预览方式展示属性列表，允许用户勾选、排序和调整可视权重，生成最终砖块配置
  */
 export declare class PreGeneratedConfig extends ReactNextElement implements PreGeneratedConfigProps {
     #private;
+    /**
+     * 预览 iframe 的地址，默认使用内置预览地址
+     */
     accessor previewUrl: string | undefined;
+    /**
+     * 属性列表，支持对象属性（ObjectAttr）和指标属性（MetricAttr）
+     */
     accessor attrList: ObjectAttr[] | undefined;
+    /**
+     * 模拟数据列表，用于在预览列中展示真实渲染效果
+     */
     accessor mockList: Record<string, unknown>[] | undefined;
+    /**
+     * 指标分组配置，仅在 containerConfig.type 为 "grouped-chart" 时生效
+     */
     accessor metricGroups: MetricGroup[] | undefined;
+    /**
+     * 容器配置，决定生成的砖块布局类型（table/descriptions/cards/chart/grouped-chart）及数据绑定
+     */
     accessor containerConfig: ContainerConfig | undefined;
     render(): React.JSX.Element;
 }

package/dist-types/pre-generated-config-preview/index.d.ts

@@ -16,12 +16,24 @@ export interface PreGeneratedConfigPreviewProps {
 }
 export type ContainerType = "table" | "descriptions";
 /**
- * 构件 `visual-builder.pre-generated-config-preview`
+ * AI 预生成配置预览构件，在 iframe 中将属性列表渲染为表格或描述列表，用于直观展示配置结果
  */
 export declare class PreGeneratedConfigPreview extends ReactNextElement implements PreGeneratedConfigPreviewProps {
+    /**
+     * 预览 iframe 的地址，默认使用内置预览地址
+     */
     accessor previewUrl: string | undefined;
+    /**
+     * 容器类型，"table" 渲染为表格，"descriptions" 渲染为描述列表，默认为 "table"
+     */
     accessor container: ContainerType | undefined;
+    /**
+     * 属性列表，每项包含 id、name，以及可选的可视化配置
+     */
     accessor attrList: ObjectAttr[] | undefined;
+    /**
+     * 模拟数据列表，用于填充预览中的真实数据
+     */
     accessor mockList: Record<string, unknown>[] | undefined;
     render(): React.JSX.Element;
 }

package/dist-types/pre-generated-container/index.d.ts

@@ -1,19 +1,21 @@
 import React from "react";
 import { ReactNextElement } from "@next-core/react-element";
-import type { UseBrickConf } from "@next-core/types";
+import type { UseBrickConfOrRenderFunction } from "@next-core/react-runtime";
 import "@next-core/theme";
 /**
- * 构件 `visual-builder.pre-generated-container`
+ * 预生成编排容器，使用 useBrick 渲染指定的构件配置，并将 dataSource 作为数据传入
  *
  * @internal
  */
 export declare class PreGeneratedContainer extends ReactNextElement {
-    accessor useBrick: UseBrickConf | undefined;
+    /** 要渲染的构件配置 */
+    accessor useBrick: UseBrickConfOrRenderFunction | undefined;
+    /** 传入构件的数据 */
     accessor dataSource: unknown | undefined;
     render(): React.JSX.Element;
 }
 export interface PreGeneratedContainerProps {
-    useBrick?: UseBrickConf;
+    useBrick?: UseBrickConfOrRenderFunction;
     dataSource?: unknown;
 }
 export declare function PreGeneratedContainerComponent({ useBrick, dataSource, }: PreGeneratedContainerProps): React.JSX.Element;

package/dist-types/pre-generated-preview/index.d.ts

@@ -22,18 +22,23 @@ export interface AttributeGeneration {
 }
 export type PreviewCategory = "detail-item" | "form-item" | "table-column" | "card-item" | "metric-item" | "value";
 /**
- * 构件 `visual-builder.pre-generated-preview`
+ * 预生成编排预览，在 iframe 中渲染属性生成结果的对比表格
  *
  * @internal
  */
 export declare class PreGeneratedPreview extends ReactNextElement {
+    /** 属性生成数据列表 */
     accessor generations: AttributeGeneration[] | undefined;
     /**
+     * 预览分类，影响数据容器的渲染方式
      * @default "value"
      */
     accessor category: PreviewCategory | undefined;
+    /** 预览主题 */
     accessor theme: string | undefined;
+    /** UI 版本 */
     accessor uiVersion: string | undefined;
+    /** 微应用信息 */
     accessor app: MicroApp | undefined;
     render(): React.JSX.Element;
 }

package/dist-types/pre-generated-table-view/index.d.ts

@@ -2,7 +2,7 @@ import React from "react";
 import { ReactNextElement } from "@next-core/react-element";
 import "@next-core/theme";
 /**
- * 构件 `visual-builder.pre-generated-table-view`
+ * 预生成编排表格视图，使用 CSS Grid 布局渲染子构件
  *
  * @internal
  */

package/dist-types/property-editor/index.d.ts

@@ -458,21 +458,27 @@ export declare const SchemaField: {
 };
 export type { DataNode };
 /**
- * 构件 `visual-builder.property-editor`
+ * 构件属性编辑器，基于 Formily 渲染指定构件的属性编辑表单
  */
 export declare class PropertyEditor extends ReactNextElement {
     #private;
-    /** 构件名称 */
+    /** 构件名称，用于加载对应的属性编辑器 */
     accessor editorName: string | undefined;
-    /** 值 */
+    /** 属性编辑器的当前值 */
     accessor values: any | undefined;
-    /** 高级模式 */
+    /** 是否启用高级模式，高级模式下直接编辑原始属性对象 */
     accessor advancedMode: boolean | undefined;
+    /** 数据列表，用于编辑器中的数据绑定选项 */
     accessor dataList: DataItem[];
+    /** 构件包信息，用于加载自定义编辑器 */
     accessor editorPackages: BrickPackage[];
+    /** 链接配置，用于编辑器中的跳转链接选项 */
     accessor links: any;
+    /** 额外的代码补全库，用于代码编辑器的类型提示 */
     accessor extraLibs: SelectOptions;
+    /** 子插槽选项，用于编辑器中选择子插槽 */
     accessor childSlots: SelectOptions;
+    /** 触发表单校验，验证成功后触发 validate.success 事件，失败后触发 validate.error 事件 */
     validate(): void;
     render(): React.JSX.Element;
 }

package/dist-types/raw-data-preview/index.d.ts

@@ -37,22 +37,30 @@ export interface ApproveDetail {
 }
 export type PreviewCategory = "detail-item" | "form-item" | "table-column" | "card-item" | "metric-item" | "value";
 /**
- * 构件 `visual-builder.raw-data-preview`
+ * 原始数据预览，在 iframe 中渲染属性生成候选编排的对比表格，支持批注和确认操作
  *
  * @internal
  */
 export declare class RawDataPreview extends ReactNextElement {
     #private;
+    /** 预览 iframe 地址，默认使用内置预览地址 */
     accessor previewUrl: string | undefined;
+    /** 属性生成数据列表 */
     accessor generations: AttributeGeneration[] | undefined;
+    /** 模拟数据列表，作为各属性的候补示例数据 */
     accessor mocks: Record<string, unknown>[] | undefined;
+    /** 是否处于加载中状态，为 true 时禁用批注和确认操作 */
     accessor busy: boolean | undefined;
     /**
+     * 预览分类，影响数据容器的渲染方式
      * @default "value"
      */
     accessor category: PreviewCategory | undefined;
+    /** 预览主题 */
     accessor theme: string | undefined;
+    /** UI 版本 */
     accessor uiVersion: string | undefined;
+    /** 微应用信息 */
     accessor app: MicroApp | undefined;
     render(): React.JSX.Element;
 }

package/dist-types/raw-metric-preview/index.d.ts

@@ -38,17 +38,24 @@ export interface ApproveDetail {
     propertyInstanceId?: string;
 }
 /**
- * 构件 `visual-builder.raw-metric-preview`
+ * 原始指标预览，在 iframe 中渲染指标生成候选图表的对比表格
  *
  * @internal
  */
 export declare class RawMetricPreview extends ReactNextElement {
+    /** 预览 iframe 地址，默认使用内置预览地址 */
     accessor previewUrl: string | undefined;
+    /** 指标生成数据列表 */
     accessor generations: MetricGeneration[] | undefined;
+    /** 是否按分组显示，启用后表格额外显示分组列 */
     accessor grouped: boolean | undefined;
+    /** 是否处于加载中状态 */
     accessor busy: boolean | undefined;
+    /** 预览主题 */
     accessor theme: string | undefined;
+    /** UI 版本 */
     accessor uiVersion: string | undefined;
+    /** 微应用信息 */
     accessor app: MicroApp | undefined;
     render(): React.JSX.Element;
 }

package/dist-types/workbench-action/index.d.ts

@@ -11,14 +11,21 @@ export interface WorkbenchActionProps {
     tooltip?: string;
 }
 /**
+ * 工作台侧边栏操作按钮，显示图标链接并在右侧显示 tooltip
  * @insider
  */
 export declare class WorkbenchAction extends ReactNextElement {
+    /** 按钮图标配置 */
     accessor icon: GeneralIconProps | undefined;
+    /** 路由跳转地址 */
     accessor to: string | undefined;
+    /** 是否处于激活状态 */
     accessor active: boolean | undefined;
+    /** 外部链接地址 */
     accessor href: string | undefined;
+    /** 链接打开方式 */
     accessor target: string | undefined;
+    /** 鼠标悬停时显示的提示文字 */
     accessor tooltip: string | undefined;
     render(): React.ReactNode;
 }

package/dist-types/workbench-action-list/index.d.ts

@@ -13,10 +13,13 @@ interface WorkbenchActionListProps {
     menu: SidebarMenu;
 }
 /**
+ * 工作台侧边栏操作列表，根据菜单配置渲染一组 workbench-action 按钮，并根据当前路由高亮激活项
  * @insider
  */
 declare class WorkbenchActionList extends ReactNextElement {
+    /** 当前应用 ID，用于在切换应用时重置历史记录 */
     accessor appId: string | undefined;
+    /** 侧边栏菜单配置 */
     accessor menu: SidebarMenu;
     render(): React.ReactNode;
 }

package/dist-types/workbench-pane/index.d.ts

@@ -8,12 +8,16 @@ export interface WorkbenchPaneProps {
     onFirstActivated?(): void;
 }
 /**
+ * 工作台侧边栏面板，可折叠的内容面板，包含标题栏和可滚动的内容区
  * @insider
  */
 declare class WorkbenchPane extends ReactNextElement {
     #private;
+    /** 面板标题文本 */
     accessor titleLabel: string | undefined;
+    /** 是否展开面板 */
     accessor active: boolean | undefined;
+    /** 标题栏右侧的数字徽标 */
     accessor badge: number | undefined;
     render(): React.JSX.Element;
 }

package/dist-types/workbench-sidebar/index.d.ts

@@ -1,10 +1,12 @@
 import React from "react";
 import { ReactNextElement } from "@next-core/react-element";
 /**
+ * 工作台侧边栏容器，包含标题栏和面板容器，自动管理子面板（workbench-pane）的展开/折叠布局
  * @insider
  */
 declare class WorkbenchSidebar extends ReactNextElement {
     #private;
+    /** 侧边栏标题文本 */
     accessor titleLabel: string | undefined;
     refCallback: () => void;
     render(): React.JSX.Element;

package/dist-types/workbench-tree/index.d.ts

@@ -3,33 +3,46 @@ import { ReactNextElement } from "@next-core/react-element";
 import type { WorkbenchNodeData, WorkbenchTreeAction } from "../interfaces.js";
 import "@next-core/theme";
 /**
- * @id next-builder.workbench-tree
- * @author steve
- * @history
- * 1.x.0: 新增构件 `next-builder.workbench-tree`
- * @docKind brick
- * @noInheritDoc
+ * 工作台树形组件，支持搜索、拖拽排序、折叠展开和节点操作
  * @insider
  */
 declare class WorkbenchTreeElement extends ReactNextElement {
     #private;
+    /** 树节点数据列表 */
     accessor nodes: WorkbenchNodeData[];
+    /** 节点操作按钮配置列表 */
     accessor actions: WorkbenchTreeAction[];
+    /** 是否隐藏节点操作按钮 */
     accessor actionsHidden: boolean;
+    /** 无数据时显示的占位文本 */
     accessor placeholder: string;
+    /** 是否将节点名称转换为可读格式 */
     accessor isTransformName: boolean;
+    /** 搜索框占位文本 */
     accessor searchPlaceholder: string;
+    /** 是否隐藏搜索框 */
     accessor noSearch: boolean;
+    /** 当前激活节点的 key */
     accessor activeKey: string | number;
+    /** 搜索时是否只显示匹配的节点 */
     accessor showMatchedNodeOnly: boolean;
+    /** 搜索时匹配的节点数据字段，"*" 表示匹配所有字段 */
     accessor matchNodeDataFields: string | string[];
+    /** 始终显示操作按钮的节点数据条件 */
     accessor fixedActionsFor: Record<string, unknown> | Record<string, unknown>[];
+    /** 是否启用节点折叠功能 */
     accessor collapsible: boolean;
+    /** 当前已折叠节点的 ID 列表 */
     accessor collapsedNodes: string[];
+    /** 是否允许拖拽排序 */
     accessor allowDrag: boolean;
+    /** 是否允许拖拽到根节点位置 */
     accessor allowDragToRoot: boolean;
+    /** 是否允许拖拽到节点内部成为子节点 */
     accessor allowDragToInside: boolean;
+    /** 节点唯一标识字段名 */
     accessor nodeKey: string;
+    /** 是否跳过节点点击时的通知 */
     accessor skipNotify: boolean;
     render(): React.JSX.Element;
 }