@huanban/rulego-editor-react 1.3.12 → 1.3.13

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -114,7 +114,7 @@ function EditorPage({ chainId }: { chainId: string }) {
114
114
  | `onNodeClick` | `(node) => void` | - | 节点点击回调 |
115
115
  | `onNodeDbClick` | `(node) => void` | - | 节点双击回调 |
116
116
  | `onEdgeClick` | `(edge) => void` | - | 边点击回调 |
117
- | `onSave` | `(data) => void \| Promise<void>` | - | 保存回调 |
117
+ | `onSave` | `(data) => boolean \| { success?: boolean; message?: string } \| Promise<...>` | - | 宿主接管保存回调;不传时内置 `POST + GET` 保存校验 |
118
118
  | `onDeploy` | `(chainId, action: 'start' \| 'stop' \| 'reload') => void \| Promise<void>` | - | 部署/下线/重载回调;部署对应 `start`,下线对应 `stop` |
119
119
 
120
120
  ---
@@ -153,6 +153,39 @@ function EditorPage({ chainId }: { chainId: string }) {
153
153
 
154
154
  ---
155
155
 
156
+ ### 保存协议
157
+
158
+ 默认不要传 `onSave`。只要配置了 `apiBase`,保存按钮会直接调用:
159
+
160
+ ```text
161
+ POST {apiBase}/rules/:id
162
+ GET {apiBase}/rules/:id
163
+ ```
164
+
165
+ 第二次 `GET` 用于回读校验,只有后端返回的数据与当前画布一致时才会显示已保存。
166
+
167
+ 只有宿主确实要完全接管保存时才传 `onSave`。接管后必须返回明确结果:
168
+
169
+ ```tsx
170
+ <RuleGoEditor
171
+ apiBase={apiBase}
172
+ data={chainData}
173
+ onSave={async (data: any) => {
174
+ const id = data?.ruleChain?.id
175
+ const resp = await fetch(`${apiBase}/rules/${encodeURIComponent(id)}`, {
176
+ method: 'POST',
177
+ headers: { 'Content-Type': 'application/json', ...fetchHeaders() },
178
+ body: JSON.stringify(data),
179
+ })
180
+ return resp.ok ? { success: true } : { success: false, message: `HTTP ${resp.status}` }
181
+ }}
182
+ />
183
+ ```
184
+
185
+ 如果只是打印日志,不要传 `onSave`,否则会改变保存语义。需要观察变化时使用 `onChange` 或浏览器日志。
186
+
187
+ ---
188
+
156
189
  ## 二、WorkflowList — 工作流列表
157
190
 
158
191
  展示所有规则链,支持搜索、分页、创建、部署/下线、复制、删除、详情联动和编辑跳转。它是独立管理组件,不是编辑器;进入画布编辑需要在 `onDesign` 中切换到 `RuleGoEditor`。
@@ -101,6 +101,8 @@ export interface RuleGoEditorProps {
101
101
  showComponentManage?: boolean;
102
102
  /** 是否显示部署按钮, 默认 true */
103
103
  showDeployButton?: boolean;
104
+ /** 是否显示兼容保留的重载按钮, 默认 false */
105
+ showReloadButton?: boolean;
104
106
  /** 是否显示运行记录按钮 */
105
107
  showRunHistory?: boolean;
106
108
  /** 运行记录 URL (支持 {chainId} 占位符) */