@digitalsee-ai/rcs 1.0.0 → 1.0.1

package/README.md

@@ -1,237 +1,69 @@
-  ![logo](https://www.digitalsee.cn/_next/static/media/logo_purple.a1d68599.svg)
-  
-  # @digitalsee/rcs
-  
-  **数犀 React 组件库**
+# @digitalsee-ai/rcs
 
-  
- 为数犀内部提供跨工程运行的React组件服务
-  
+数犀 React 组件库，当前主要提供工作流画布、DynamicForm 和 JsonRenderer。
 
----
+## 环境要求
 
-## 📦 安装
+- Node.js `>= 22`
+- pnpm `10.12.1`
 
-使用 pnpm（推荐）:
-```bash
-pnpm add @digitalsee/rcs
-```
+## 安装与使用
 
-使用 npm:
 ```bash
-npm install @digitalsee/rcs
+pnpm add @digitalsee-ai/rcs
 ```
 
-使用 yarn:
-```bash
-yarn add @digitalsee/rcs
-```
-
-## ✨ 特性
-
-- 🎨 **工作流编辑器** - 基于 ReactFlow 的强大可视化工作流编辑器
-- 📊 **数据可视化** - 内置 JSON 渲染器和数据展示组件
-- 🌍 **国际化支持** - 内置中文（简体/繁体）和英文支持
-- 🎯 **TypeScript** - 完整的 TypeScript 类型支持
-- 🔧 **可定制** - 灵活的配置和主题定制
-- ⚡ **高性能** - 优化的渲染性能和内存使用
-- 📱 **响应式** - 适配各种屏幕尺寸
-
-## 🚀 快速开始
-
-### 基础使用
-
 ```tsx
-import { Workflow } from '@digitalsee/rcs';
-import '@digitalsee/rcs/styles.css';
-
-function App() {
-  return (
-    <Workflow
-      workflowId="my-workflow"
-      // 更多配置项...
-    />
-  );
+import { DigitalseeWorkFlow } from '@digitalsee-ai/rcs';
+import '@digitalsee-ai/rcs/styles.css';
+
+export function WorkflowPage() {
+  return <DigitalseeWorkFlow workflowId="workflow-id" />;
 }
 ```
 
-### 使用 JsonRenderer
+DynamicForm 示例：
 
 ```tsx
-import { JsonRenderer } from '@digitalsee/rcs';
-import '@digitalsee/rcs/styles.css';
+import { DynamicForm, DynamicFormField, type FormSchema } from '@digitalsee-ai/rcs';
+import '@digitalsee-ai/rcs/styles.css';
 
-function App() {
-  const data = {
-    name: "示例数据",
-    value: 123
-  };
+const schema: FormSchema = {
+  fields: [{ type: DynamicFormField.TEXT, name: 'name', label: '名称' }],
+};
 
-  return <JsonRenderer data={data} />;
+export function FormPage() {
+  return <DynamicForm schema={schema} />;
 }
 ```
 
-## 📚 主要组件
-
-### 🔄 Workflow（工作流）
-
-完整的可视化工作流编辑器，支持：
-
-- ✅ 节点的拖拽和连接
-- ✅ 自定义节点类型
-- ✅ 边的样式和交互
-- ✅ 撤销/重做功能
-- ✅ 小地图导航
-- ✅ 自动布局
-- ✅ 调试面板
-- ✅ 数据持久化
-
-**主要特性：**
-- 支持多种节点类型（触发器、动作、条件等）
-- 灵活的节点配置面板
-- 实时数据流调试
-- 节点搜索和筛选
-- 快捷键支持
-
-### 📋 JsonRenderer
-
-强大的 JSON 数据渲染组件：
-- 语法高亮
-- 可折叠/展开
-- 搜索功能
-- 复制功能
-
-## 🔨 开发
-
-### 环境要求
-
-- Node.js >= 22
-- pnpm >= 10.12.1
-
-### 开发命令
+## 开发命令
 
 ```bash
-# 安装依赖
 pnpm install
-
-# 启动 Storybook 开发环境
-pnpm dev
-
-# 构建组件库
-pnpm build:vite
-
-# 运行测试
-pnpm test
-
-# 代码格式化
-pnpm format
-
-# 代码检查
-pnpm lint
-```
-
-### 构建输出
-
-```bash
-# 构建并发布新版本
-pnpm update:version
-```
-
-构建产物包括：
-- `dist/rcs.es.js` - ES Module 格式
-- `dist/rcs.umd.js` - UMD 格式
-- `dist/rcs.css` - 样式文件
-- `dist/index.d.ts` - TypeScript 类型定义
-
-## 🎨 技术栈
-
-- **核心框架**: React 19+
-- **状态管理**: Redux Toolkit
-- **流程图**: @xyflow/react
-- **UI 组件**: Ant Design 5+ / Ant Design Pro Components
-- **样式方案**: Tailwind CSS + Less
-- **代码编辑器**: Monaco Editor / CodeMirror
-- **富文本**: Slate.js
-- **构建工具**: Vite
-- **文档工具**: Storybook
-- **代码质量**: Biome
-- **测试框架**: Vitest
-
-## 📖 依赖要求
-
-### Peer Dependencies
-
-确保你的项目中已安装以下依赖：
-
-- `react` >= 18.0.0
-- `react-dom` >= 18.0.0
-- `antd` >= 5.0.0
-- `@ant-design/icons` >= 5.0.0
-- `@ant-design/pro-components` >= 2.0.0
-- `@reduxjs/toolkit` >= 2.0.0
-- `react-redux` >= 9.0.0
-- `@xyflow/react` >= 12.0.0
-- `ahooks` >= 3.0.0
-- `lodash-es` >= 4.17.0
-
-## 🌐 国际化
-
-组件库内置多语言支持：
-
-```tsx
-import { IntlProvider } from 'react-intl';
-import zhCN from '@digitalsee/rcs/locales/zh-CN';
-
-<IntlProvider locale="zh-CN" messages={zhCN}>
-  <Workflow />
-</IntlProvider>
+pnpm dev          # Storybook，默认 http://localhost:8888
+pnpm build:lib    # tsc + Vite，生成 dist
+pnpm build:vite   # 仅 Vite 构建，适合快速联调
+pnpm tsc          # 类型检查
+pnpm test         # Vitest watch
+pnpm test:cov     # 单次运行并生成覆盖率
+pnpm format       # Biome 格式化 src
+pnpm lint         # Biome lint 并自动修复 src
 ```
 
-支持的语言：
-- 🇨🇳 简体中文 (zh-CN)
-- 🇹🇼 繁体中文 (zh-TW)
-- 🇺🇸 英文 (en-US)
-
-## 📝 版本管理
-
-```bash
-# 补丁版本 (0.0.x)
-pnpm bump
-
-# 次要版本 (0.x.0)
-pnpm bump:minor
-
-# 主要版本 (x.0.0)
-pnpm bump:major
-```
-
-## 🤝 贡献
-
-欢迎提交 Issue 和 Pull Request！
-
-### 开发流程
-
-1. Fork 本仓库
-2. 创建你的特性分支 (`git checkout -b feature/AmazingFeature`)
-3. 提交你的改动 (`git commit -m 'Add some AmazingFeature'`)
-4. 推送到分支 (`git push origin feature/AmazingFeature`)
-5. 提交 Pull Request
-
-### 代码规范
-
-项目使用 Biome 进行代码检查和格式化：
-```bash
-pnpm format  # 自动格式化代码
-pnpm lint    # 检查代码问题
-```
+`dist/` 是 npm 包实际消费的构建产物。修改源码后，宿主项目不会自动获得更新，需重新构建。
 
+## 文档
 
-## 🔗 相关链接
+- [文档索引与维护状态](docs/README.md)
+- [本地联调 npm 包](docs/development/local-package-debugging.md)
+- [工作流组件集成](docs/guides/workflow-integration.md)
+- [发布说明](docs/development/publishing.md)
 
-- [数犀官网](https://www.digitalsee.cn)
+## 包导出
 
----
+- `@digitalsee-ai/rcs`：组件、类型与工具
+- `@digitalsee-ai/rcs/styles.css`：组件库样式
 
-<div align="center">
-  Made with ❤️ by <a href="https://www.digitalsee.cn">数犀 DigitalSee</a>
-</div>
+构建产物包括 `dist/rcs.es.js`、`dist/rcs.umd.js`、`dist/rcs.css` 和
+`dist/index.d.ts`。

package/dist/components/digitalsee/workflow/api/dip.d.ts

@@ -98,7 +98,7 @@ export declare function dipGetNodeSchema(nodeKey: string, version?: number): Pro
  * @param request - 节点测试请求参数
  * @returns 节点测试结果（含 outputData、resolvedParams、executionTimeMs）
  * @see POST /api/nodes/test
- * @see doc/node-test-api-guide.md
+ * @see docs/reference/node-test-api.md
  */
 export declare function dipTestNode(request: DipNodeTestRequest): Promise<DipNodeTestResult>;
 /**

package/dist/components/digitalsee/workflow/api/dip.types.d.ts

@@ -937,7 +937,7 @@ export interface DipPageWorkflowDefinitionEntity {
  * 对应后端 {@link NodeTestRequest} record，提交给 `POST /api/nodes/test`。
  * 前端负责管理测试历史和上下文，后端完全无状态，支持集群部署。
  *
- * @see doc/node-test-api-guide.md
+ * @see docs/reference/node-test-api.md
  */
 export interface DipNodeTestRequest {
     /** 节点类型标识（必填），如 `"http_request"` */

package/dist/components/digitalsee/workflow/config/globalConfig.d.ts

@@ -11,7 +11,7 @@ interface GlobalWorkflowConfig {
  *
  * @example
  * ```typescript
- * import { configureWorkflow } from 'digitalsee-rcs';
+ * import { configureWorkflow } from '@digitalsee-ai/rcs';
  * import axios from 'axios';
  * import { useHistory } from 'react-router-dom';
  *

package/dist/components/digitalsee/workflow/index.d.ts

@@ -1,6 +1,5 @@
-import { default as React } from 'react';
 import { default as defaultCanvasEngineConfig } from './config/defaultCanvasEngineConfig';
-import { CanvasEngineConfig, HistoryNavigator, HttpClient } from './types/engine';
+import { CanvasEngineConfig, DeepPartial, HistoryNavigator, HttpClient, CanvasAPI } from './types/engine';
 import { mergeConfig } from './utils/mergeConfig';
 import { LocaleType } from '../../../locales';
 import { EngineMode } from './enums/workflow';
@@ -46,12 +45,18 @@ export interface DigitalseeWorkFlowProps {
      * @param workflow 当前工作流数据
      */
     onSave?: (workflow: any) => void;
+    /**
+     * 画布初始化回调
+     *
+     * @param api 画布对外 API
+     */
+    onInit?: (api: CanvasAPI) => void;
     /**
      * 画布配置
      *
      * @description 支持传入局部配置，内部会与默认配置做深度合并
      */
-    config?: Partial<CanvasEngineConfig>;
+    config?: DeepPartial<CanvasEngineConfig>;
     /**
      * Locale override for workflow translations
      *
@@ -95,11 +100,14 @@ export interface DigitalseeWorkFlowProps {
  *
  * @param props 组件参数
  */
-declare const DigitalseeWorkFlow: React.FC<DigitalseeWorkFlowProps>;
+declare const DigitalseeWorkFlow: (props: DigitalseeWorkFlowProps) => any;
 export { DigitalseeWorkFlow };
 export type { WorkflowHttpClient } from './api';
-export type { CanvasEngineConfig, HistoryNavigator, HttpClient, } from './types/engine';
-export { EngineMode } from './enums/workflow';
+export type { CanvasAPI, CanvasEngineConfig, DeepPartial, HistoryNavigator, HttpClient, } from './types/engine';
+export { EngineMode, WorkflowOpStatus } from './enums/workflow';
+export { NodeStatus, NodeType } from './enums/node';
+export { useCanvasApi } from './context/canvasApiContext';
+export { useCanvasConfig } from './context/canvasConfig';
 export { defaultCanvasEngineConfig, mergeConfig };
 export type { LocaleType as WorkflowLocale, TranslateFn as WorkflowTranslateFn, } from '../../../locales';
 export { createTranslator } from '../../../locales';

package/dist/components/digitalsee/workflow/types/engine.d.ts

@@ -1,7 +1,7 @@
 import { ReactFlow } from '@xyflow/react';
 import { ComponentProps, ReactNode } from 'react';
 import { Rule } from 'antd/es/form';
-import { EngineMode } from '../enums/workflow';
+import { EngineMode, WorkflowOpStatus } from '../enums/workflow';
 export type HttpClient = <T = any>(url: string, config: any) => Promise<T>;
 export interface HistoryNavigator {
     push(path: string, state?: any): void;
@@ -11,6 +11,9 @@ export interface HistoryNavigator {
     goForward(): void;
     listen?(listener: (location: any, action: any) => void): () => void;
 }
+export type DeepPartial<T> = {
+    [P in keyof T]?: T[P] extends (...args: any[]) => any ? T[P] : T[P] extends Array<infer U> ? Array<DeepPartial<U>> : T[P] extends object ? DeepPartial<T[P]> : T[P];
+};
 export interface CanvasEngineConfig {
     flowId: string;
     engineMode?: EngineMode;
@@ -58,6 +61,7 @@ export interface CanvasCoreConfig {
 }
 export interface NodeTypesRegistryConfig {
     types: Record<string, NodeTypeConfig>;
+    nodeBlackList?: string[];
     fixed?: {
         triggers?: string[];
         finalAction?: string;
@@ -148,6 +152,8 @@ export interface ToolbarButtonConfig {
     icon?: ReactNode;
     style?: Record<string, any>;
     type?: 'link' | 'text' | 'default' | 'primary' | 'dashed';
+    danger?: boolean;
+    loading?: boolean;
     onClick?: (ctx: CanvasAPI) => void;
 }
 export interface NodeConfigPanelConfig {
@@ -190,6 +196,7 @@ export interface CanvasAPI {
     init(): void;
     destroy(): void;
     refresh(): void;
+    setFlowOpStatus(status: WorkflowOpStatus): void;
     getData(): FlowData;
     setData(flow: FlowData): void;
     exportJSON(): any;

package/dist/components/digitalsee/workflow/utils/mergeConfig.d.ts

@@ -1,7 +1,4 @@
-/**
- * mergeConfig - Deep merge helper for CanvasEngineConfig
- * 支持深度合并、数组自定义合并策略、对象合并、函数覆盖
- */
+import { DeepPartial } from '../types/engine';
 type MergeArrayStrategy = 'append' | 'override' | 'mergeById';
 /**
  * merge options
@@ -13,10 +10,10 @@ export interface MergeConfigOptions {
 /**
  * Deep merge core function
  */
-export declare function mergeDeep<T>(target: Partial<T>, source: Partial<T>, options?: MergeConfigOptions): T;
+export declare function mergeDeep<T>(target: T | DeepPartial<T>, source: DeepPartial<T>, options?: MergeConfigOptions): T;
 /**
  * 业务常用：合并 CanvasEngineConfig
  * mergeConfig(defaultConfig, customConfig)
  */
-export declare function mergeConfig<T>(base: T, override: Partial<T>, options?: MergeConfigOptions): T;
+export declare function mergeConfig<T>(base: T, override: DeepPartial<T>, options?: MergeConfigOptions): T;
 export default mergeConfig;