@bpmn-nova/react 0.3.5-preview → 0.3.7-preview

package/README.md

@@ -4,7 +4,7 @@ BPMN Nova 的 React 18+ Adapter，提供 Studio、Designer、Viewer、审批轨
 
 > **English summary:** React 18+ components and refs for BPMN Nova process design, viewing, approval traces, properties, themes, and SVG export.
 
-> 当前版本为 `0.3.5-preview`。React 与 React DOM 由宿主工程提供，本包不会替应用选择或升级框架版本。
+> 当前版本为 `0.3.7-preview`。React 与 React DOM 由宿主工程提供，本包不会替应用选择或升级框架版本。
 
 ![BPMN Nova React 流程工作台](https://raw.githubusercontent.com/daxiangme/bpmn-nova/dev/docs/assets/bpmn-nova-designer.jpg)
 
@@ -14,29 +14,11 @@ BPMN Nova 的 React 18+ Adapter，提供 Studio、Designer、Viewer、审批轨
 npm install @bpmn-nova/react@preview
 ```
 
-```jsx
-import '@bpmn-nova/react/styles.css'
-```
-
-只安装本包；`@bpmn-nova/studio` 会作为内部依赖自动解析。容器必须有明确高度。
-
-TypeScript 类型也从 React 入口导入，不要为了模型类型额外声明 Studio 直依赖：
+只安装本包；匹配版本的 `@bpmn-nova/studio` 会作为依赖自动解析。公共 TypeScript 类型直接从 `@bpmn-nova/react` 导入，不需要为类型额外添加 Studio 直依赖。
 
-```ts
-import type {
-  BpmnNode,
-  EdgeType,
-  ElementSelection,
-  NodeType,
-  ProcessModel,
-} from '@bpmn-nova/react'
-```
-
-公共类型门面还包含 `BpmnEdge`、`EngineId` 和 `LayoutOptions`。
-
-使用代码生成助手或 IDE Agent 接入时，从随包的 `llms.txt` 开始；需要完整接口和定制资料时再读取 `llms-full.txt`。两份文件都包含在 npm tarball 中，不依赖源码仓库可见性。
+CSS 必须显式导入 `@bpmn-nova/react/styles.css`；视觉容器及其父级需要具有可计算高度。
 
-## 流程设计
+## 最小用法
 
 ```jsx
 import { useRef } from 'react'
@@ -67,274 +49,17 @@ export function WorkflowEditor({ initialXml }) {
 }
 ```
 
-Ref 提供 `actions`、`validate()`、`exportXml()`、`fitView()`、`setTheme()`、`exportSvg()` 和 `openSvgExportPreview()`。
-
-`xml`/`model` 是外部替换输入，`onChange` 的 XML 是草稿输出。宿主回写完全相同的导出 XML 不会重新导入或清空撤销历史；切换服务器 revision 或流程时传入不同 XML 会替换模型。Activiti 宿主应显式使用 `engine="activiti"`。
-
-## 组合宿主头部与业务属性面板
-
-默认 `BpmnStudio` 是完整工作台。下面展示宿主拥有外部面板的接法：通过 `config.ui.regions.right = 'hidden'` 隐藏 Nova Properties，Canvas 获得该轨道的全部宽度。若希望复用 Nova 侧栏布局，使用下文的 `right` Render Prop，不必放到外部。
-
-```jsx
-<BpmnStudio
-  ref={studioRef}
-  xml={xml}
-  engine="activiti"
-  mode="design"
-  allowedModes={['design']}
-  config={{
-    modeling: { allowedNodeTypes: supportedNodeTypes, allowedEdgeTypes: ['sequenceFlow'] },
-    ui: { controlSize: 'medium', regions: { right: 'hidden' } },
-  }}
-  theme="auto"
-  headerStart={({ state, actions }) => (
-    <HostProcessIdentity onBack={back} />
-  )}
-  headerActions={({ actions, mode, ui }) => (
-    <HostWorkflowActions
-      disabled={mode !== 'design'}
-      onValidate={() => actions.validate()}
-      onSave={() => saveDraft(actions.exportXml())}
-      onPublish={() => publishProcess(actions)}
-    />
-  )}
-  onChange={handleChange}
-  onValidation={(event) => handleValidation(event)}
-  onSelectionChange={(selection, element) => {
-    setSelectedElement(selection ? element : null)
-  }}
-/>
-```
-
-`headerStart` 只替换 Nova Brand；`headerActions` 只替换默认“校验 / 导入 / 导出”动作组，适合组合“校验 / 保存 / 发布”；`header` 可完整替换 Header。它们都通过 React Portal 在当前组件树内渲染，保留 Context 和生命周期。默认 Header 的最佳视图只保留在底部缩放区。
-
-`actions.validate()` 以 `toolbar` 来源先更新 Nova 默认状态栏，再调用 `onValidation` 并返回 issues；Ref `validate()` 使用 `api` 来源。事件的 `valid` 仅由 error 决定，warning 会保留在 `issues` 中但不默认阻止发布。保存与发布仍由宿主负责。
-
-```js
-async function publishProcess(actions) {
-  const issues = actions.validate()
-  if (issues.some((issue) => issue.level === 'error')) return
-  await publishXml(actions.exportXml())
-}
-```
-
-宿主属性面板以 `onSelectionChange` 为选择状态来源；它覆盖节点、连线、多选、清空与键盘选择。`onElementClick` 只是点击观察事件，不能代替选择状态。宿主通过稳定 BPMN Element ID 关联业务配置，并自行负责保存、发布、权限与服务端事务。
-
-`config` 收拢 `modeling/ui/viewer/export` 静态选项。顶部控件尺寸使用 `config.ui.controlSize`，默认 `medium`，支持 `small`、`medium`、`large` 和 `24px`–`48px`。Render Context 的只读 `ui.controlHeight` 可交给宿主按钮；Element Plus `default`、Ant Design `middle` 都映射到 Nova `medium`。自定义 px 时也可以在宿主 Header Actions CSS 中读取 `--nova-control-height` 等公开变量。
-
-```jsx
-<BpmnStudio
-  ref={studioRef}
-  config={{ ui: { controlSize: '36px' } }}
-  headerActions={({ actions, ui }) => (
-    <HostActions actions={actions} buttonHeight={ui.controlHeight} />
-  )}
-/>
-```
-
-Ref 同步提供 `getConfig()` / `setConfig()`；运行时更新 UI、Viewer 或 Export 不重建 Canvas。旧顶层配置继续兼容并标记 Deprecated，同项冲突时显式旧值优先。`config.modeling` 只在内部 Controller 创建时建立节点和连线约束。
-
-## 原生右侧内容与折叠
-
-`right` Render Prop 仅替换侧栏内容，保留 Nova 的布局与折叠按钮；它高于 Core `slots.right`，通过 Portal 保留宿主 Context。不要同时配置 `regions.right: 'hidden'`，否则自定义内容也隐藏。
-
-```jsx
-<BpmnStudio
-  ref={studioRef}
-  xml={xml}
-  config={{ ui: {
-    leftPanel: { collapsible: true, defaultCollapsed: false },
-    rightPanel: { collapsible: true, defaultCollapsed: false, layout: 'flex' },
-  } }}
-  onSidebarChange={(event) => console.log(event.side, event.collapsed, event.source)}
-  right={({ panelSelection, mode }) => (
-    <>
-      <header style={{ flex: 'none', padding: 12 }}>业务详情 · {mode}</header>
-      <div style={{ flex: 1, minHeight: 0, overflow: 'auto', padding: 12 }}>
-        {panelSelection.selectedElement?.id ?? '未选择元素'}
-        {/* 填入宿主表单 */}
-      </div>
-      <footer style={{ flex: 'none', padding: 12 }}>宿主固定操作区</footer>
-    </>
-  )}
-/>
-```
-
-默认 `flex` 由宿主安排内部滚动；`scroll` 由 Nova 滚动整个内容，宿主只填普通内容。父容器仍需可计算高度。收起不卸载内容、不丢失表单/滚动状态、不自动 Fit；左右按钮位于分隔线中点，支持键盘和尊重减少动态效果的 200ms 动画。Shell 容器 ≤720px 时首次默认收起，保留按钮，展开挤压画布而非抽屉，宽窄屏分别记忆状态。
-
-Ref 增加 `getSidebarState()`、`setSidebarCollapsed(side, collapsed)`、`subscribeSidebarChange()`、`getPanelSelection()`、`subscribePanelSelection()`；设置仅在实际切换时返回 `true`。Header/Right Render Context 共享响应式 `panelSelection`（`selection`、`selectedElement`、`trace`），只读轨迹选择不回写设计选择。
-
-Instance 默认隐藏右侧且没有展开按钮；需要时显式设置 `config.ui.regions.right: 'default'`。新增能力自 `0.3.5-preview` 提供。完整示例见[侧栏指南](https://github.com/daxiangme/bpmn-nova/blob/dev/docs/CUSTOMIZATION.md#侧栏布局与平滑折叠)或包内 `llms-full.txt`。
-
-## Mode 双向同步与副标题刷新
-
-```jsx
-import { useCallback, useRef, useState } from 'react'
-
-const [mode, setMode] = useState('design')
-const summaries = useRef(new Map())
-const resolveSubtitle = useCallback(
-  ({ node }) => summaries.current.has(node.id)
-    ? summaries.current.get(node.id)
-    : undefined,
-  [],
-)
-
-<BpmnStudio
-  ref={studioRef}
-  xml={xml}
-  mode={mode}
-  allowedModes={['design', 'viewer']}
-  onModeChange={(event) => setMode(event.mode)}
-  nodeSubtitleResolver={resolveSubtitle}
-  headerStart={({ mode: actualMode }) => (
-    <HostHeader mode={actualMode} />
-  )}
-/>
-
-function updateArchiveSummary() {
-  summaries.current.set('ServiceTask_Archive', '归档到采购系统')
-  studioRef.current?.refreshPresentation()
-}
-```
-
-Ref 的 `mode` Getter 与 `setMode()` 始终反映 Shell 实际状态。Resolver 返回 `undefined` 保留默认值、`null` 移除副标题行、字符串替换显示；函数引用变化会自动刷新，稳定闭包内部数据变化需显式调用 `refreshPresentation()`。Resolver 只影响 Design/Viewer 标准卡片和 SVG，不覆盖 Instance Runtime Presentation，也不修改 XML、History、Selection 或 Viewport。
-
-## 只读展示与审批轨迹
-
-真实后端的数据格式与接入步骤见[审批轨迹接入指南](https://github.com/daxiangme/bpmn-nova/blob/dev/docs/RUNTIME-INTEGRATION.md)，完整正文也包含在包内 `llms-full.txt`。React 根入口的 `ProcessInstanceSnapshot`、Activity/Action/Transition、`RuntimeTraceClickEvent` 与资源 Resolver 等 14 个 Runtime 类型出口自 `0.3.5-preview` 提供；旧版可按指南从 `BpmnStudioProps['runtime']` 推导，无需增加 Studio 直依赖。
-
-```jsx
-import { BpmnViewer } from '@bpmn-nova/react'
-import '@bpmn-nova/react/styles.css'
-
-export function ApprovalTrace({ xml, runtime, resolveAsset }) {
-  return (
-    <div style={{ height: 720 }}>
-      <BpmnViewer
-        xml={xml}
-        engine="flowable"
-        runtime={runtime}
-        projection="compact"
-        responsive
-        theme="auto"
-        runtimeAssetResolver={resolveAsset}
-        onTraceClick={(event) => console.log(event)}
-      />
-    </div>
-  )
-}
-```
-
-- `approval`：实际发生的有效路径。
-- `compact`：移动时间线、审批动作、图片和附件。
-- `standard`：完整 BPMN 叠加运行状态。
-
-![BPMN Nova React 移动审批时间线](https://raw.githubusercontent.com/daxiangme/bpmn-nova/dev/docs/assets/bpmn-nova-approval-mobile-timeline.jpg)
-
-## Runtime Action 与附件
-
-```js
-const runtime = {
-  processInstanceId: 'purchase-20260824',
-  status: 'running',
-  activities: [{
-    id: 'activity-manager-1',
-    elementId: 'UserTask_Manager',
-    visitId: 'visit-manager-1',
-    status: 'completed',
-    assignee: '李经理',
-  }],
-  actions: [{
-    id: 'approve-manager-1',
-    type: 'approve',
-    elementId: 'UserTask_Manager',
-    visitId: 'visit-manager-1',
-    occurredAt: '2026-08-24T10:12:00+08:00',
-    actor: { id: 'manager-li', name: '李经理' },
-    content: {
-      plainText: '资料完整，同意提交总经理审批。',
-      blocks: [{ type: 'file', assetId: 'purchase-checklist' }],
-      assets: [{
-        id: 'purchase-checklist',
-        name: '采购核验清单.txt',
-        mediaType: 'text/plain',
-        size: 248,
-      }],
-    },
-  }],
-  visitedEdges: [],
-}
-
-const resolveAsset = async (asset, { purpose, signal }) => {
-  const response = await fetch(
-    `/api/runtime-assets/${encodeURIComponent(asset.id)}?purpose=${purpose}`,
-    { signal },
-  )
-  return response.ok ? response.url : null
-}
-```
-
-Runtime Snapshot 只保存资源引用；上传、存储和权限签发由宿主负责。
-
-## 主题和 SVG 导出
-
-```jsx
-<BpmnStudio
-  ref={studioRef}
-  xml={xml}
-  theme={{
-    mode: 'auto',
-    dark: {
-      colors: {
-        canvas: '#0b1018',
-        surface: '#18202b',
-      },
-    },
-  }}
-/>
-```
-
-```js
-studioRef.current?.openSvgExportPreview({
-  theme: 'current',
-  filename: '采购申请审批流程.svg',
-})
-```
-
-主题属性变化会更新现有实例，不会重新挂载画布、清除选择或关闭详情。
-
-## Properties 与自定义 Renderer
-
-本包还导出：
-
-- `BpmnDesigner`、`BpmnCanvas`、`BpmnPalettePanel`、`BpmnPropertiesPanel`
-- `useBpmnStudio`
-- `createReactPropertyComponent`
-- `createReactRuntimeDetailsComponent`
-- `createReactRuntimeTransitionDetailsComponent`
-- `createReactRuntimeTimelineComponent`
-- `createStudioController`、`createEmptyProcess`、`importBpmn`、`exportBpmn`
-- Palette、Properties、Context Menu、Icon 和 Template Registry 的公开创建函数
-
-完整工作台可通过 `allowedNodeTypes` 与 `allowedEdgeTypes` 限制宿主支持的图元类型，通过 `allowedModes` 限制可切换的工作台模式。图元限制同时作用于 XML 导入、Palette、连接、快捷新增、模板和节点类型转换。
-
-## 常见问题
+`initialXml` 由宿主提供。组件负责实例生命周期；SSR 应用只在客户端挂载。`xml` / `model` 用于外部替换输入，事件中的 XML 是草稿输出。
 
-- **无高度：** 为外层容器设置明确高度。
-- **无样式：** 导入一次 `@bpmn-nova/react/styles.css`。
-- **Hooks/React 重复：** React 与 React DOM 应由宿主提供并保持单实例。
-- **SSR：** 将可视组件放到客户端挂载阶段。
-- **包选择：** React 项目只直接安装 `@bpmn-nova/react`。
+## 完整文档
 
-## 文档与 AI
+- [官网与文档](https://github.com/daxiangme/bpmn-nova/blob/dev/docs/src/index.md)
+- [React 接入、宿主组合和完整示例](https://github.com/daxiangme/bpmn-nova/blob/dev/docs/src/guide/react.md)
+- [组件参数与事件](https://github.com/daxiangme/bpmn-nova/blob/dev/docs/src/components/index.md)、[公开 API](https://github.com/daxiangme/bpmn-nova/blob/dev/docs/src/api/index.md)
+- [审批轨迹接入](https://github.com/daxiangme/bpmn-nova/blob/dev/docs/src/guide/runtime.md)、[自定义扩展](https://github.com/daxiangme/bpmn-nova/blob/dev/docs/src/customization/index.md)
+- [更新日志](https://github.com/daxiangme/bpmn-nova/blob/dev/docs/src/changelog.md)
 
-- npm 包内 `llms.txt`：可执行安装入口
-- npm 包内 `llms-full.txt`：完整 AI 上下文
-- [完整项目能力](https://github.com/daxiangme/bpmn-nova)
-- [React/Vue 组件说明](https://github.com/daxiangme/bpmn-nova/blob/dev/docs/COMPONENTS.md)
-- [公开 Interface](https://github.com/daxiangme/bpmn-nova/blob/dev/docs/API.md)
-- [审批轨迹接入指南](https://github.com/daxiangme/bpmn-nova/blob/dev/docs/RUNTIME-INTEGRATION.md)
+官网尚未部署，以上链接暂指向仓库文档。AI 接入从随包的 `llms.txt` 开始；`llms-full.txt` 提供完整离线上下文，两份文件都包含在 npm tarball 中。
 
 ## License
 

package/dist/index.d.ts

@@ -110,20 +110,31 @@ export type {
   StudioViewerConfig,
 } from '@bpmn-nova/studio'
 
-/** Runtime integration facade. Added in 0.3.5-preview; no runtime JavaScript exports. */
+/** Runtime integration facade. Types since 0.3.5-preview; inspectRuntime / formatRuntimeInstant since 0.3.6-preview. */
 export type {
   ActivityInstance,
   ActivityStatus,
+  ActivityVisitState,
   ProcessInstanceSnapshot,
   RuntimeApprovalAction,
   RuntimeApprovalActionType,
   RuntimeApprovalContent,
   RuntimeApprovalContentBlock,
   RuntimeAssetRef,
+  RuntimeDiagnostic,
   RuntimeEdgeVisit,
+  RuntimeInstant,
   RuntimeParticipant,
   RuntimeTransition,
 } from '@bpmn-nova/studio/runtime'
+export {
+  activityState,
+  createRuntimePresentation,
+  formatRuntimeInstant,
+  inspectRuntime,
+  normalizeRuntime,
+  parseRuntimeInstant,
+} from '@bpmn-nova/studio/runtime'
 export type {
   RuntimeAssetPurpose,
   RuntimeAssetResolver,

package/dist/index.js

@@ -7,6 +7,15 @@ import { createEmptyProcess } from '@bpmn-nova/studio';
 import { BpmnCanvas as CoreCanvas, BpmnStudioShell as CoreStudioShell, createInteractionController, createStudioController, createTemplateRegistry } from '@bpmn-nova/studio';
 import { createDefaultPaletteRegistry, PalettePanel as CorePalettePanel } from '@bpmn-nova/studio';
 
+export {
+  activityState,
+  createRuntimePresentation,
+  formatRuntimeInstant,
+  inspectRuntime,
+  normalizeRuntime,
+  parseRuntimeInstant,
+} from '@bpmn-nova/studio/runtime';
+
 export {
   createContextMenuRegistry,
   createDefaultContextMenuRegistry,

package/dist/styles.css

@@ -938,6 +938,11 @@ button.mb-runtime-action-summary:hover, button.mb-runtime-action-summary:focus-v
 .mb-runtime-timeline-content { min-width: 0; display: grid; gap: 4px; }
 .mb-runtime-timeline-card { width: 100%; min-width: 0; overflow: visible; border: 0; border-radius: 0; display: grid; color: inherit; background: transparent; box-shadow: none; }
 .mb-runtime-timeline-card-main { width: 100%; min-width: 0; border: 0; border-radius: 8px; padding: 5px 7px; display: grid; gap: 3px; color: inherit; background: transparent; text-align: left; font: inherit; cursor: pointer; transition: background-color .14s ease, box-shadow .14s ease; }
+.mb-runtime-timeline-card-main.has-avatars { grid-template-columns: auto minmax(0, 1fr); align-items: start; column-gap: 8px; }
+.mb-runtime-timeline-card-copy { min-width: 0; display: grid; gap: 3px; }
+.mb-runtime-timeline-avatars { display: flex; align-items: center; margin-top: 2px; }
+.mb-runtime-timeline-avatars .mb-runtime-details-avatar + .mb-runtime-details-avatar { margin-left: -8px; box-shadow: 0 0 0 2px var(--nova-color-surface, #fff); }
+.mb-runtime-timeline-avatar-more { font-size: var(--nova-font-size-xs, 10px); }
 .mb-runtime-timeline-card-main:hover { background: var(--nova-color-primary-soft, #f5f6ff); }
 .mb-runtime-timeline-card-main:focus-visible { outline: none; background: var(--nova-color-primary-soft, #f5f6ff); box-shadow: inset 0 0 0 2px color-mix(in srgb, var(--nova-color-primary) 22%, transparent); }
 .mb-runtime-timeline-card-main:active { background: color-mix(in srgb, var(--nova-color-primary-soft) 84%, var(--nova-color-primary)); }