@our-llm/shared 1.0.0

package/package.json

@@ -0,0 +1,17 @@
+{
+  "name": "@our-llm/shared",
+  "version": "1.0.0",
+  "type": "module",
+  "exports": {
+    "./workflow-events": {
+      "types": "./workflow-events.ts",
+      "import": "./workflow-events.ts",
+      "default": "./workflow-events.ts"
+    },
+    "./workflow.types": {
+      "types": "./workflow.types.ts",
+      "import": "./workflow.types.ts",
+      "default": "./workflow.types.ts"
+    }
+  }
+}

package/workflow-events.ts

@@ -0,0 +1,85 @@
+/**
+ * 工作流 SSE 事件协议
+ * 字段名采用缩写形式以减少流量消耗
+ *
+ * SSE event 字段用于类型判断，data 中不再重复 e 字段
+ *
+ * 字段映射：
+ * - t: threadId (线程ID)
+ * - n: nodeId (节点ID)
+ * - c: content (内容)
+ * - r: reasoning (思维过程标记，1=true)
+ * - v: variables (业务变量)
+ * - m: message (错误消息)
+ */
+
+// 工作流开始事件的 data
+export interface WorkflowStartData {
+  t: string // threadId
+}
+
+// 节点开始事件的 data
+export interface NodeStartData {
+  n: string // nodeId
+}
+
+// 节点结束事件的 data
+export interface NodeEndData {
+  n: string // nodeId
+  v?: Record<string, unknown> // variables (业务输出变量)
+  m?: SimpleMessage[] // messages (AI 返回的消息，包含图片/视频)
+}
+
+// 简化后的消息格式（与后端 SimpleMessage 保持一致）
+export interface SimpleMessage {
+  type: 'human' | 'ai' | 'system'
+  content:
+    | string
+    | Array<
+        | { type: 'text'; text: string }
+        | { type: 'image_url'; image_url: { url: string } }
+      >
+  id?: string
+  images?: string[]
+  videos?: string[]
+  documents?: Array<{ filename: string; url: string }>
+}
+
+// Token 流式事件的 data
+export interface TokenData {
+  n: string // nodeId
+  c: string // content
+  r?: 1 // isReasoning (只在 true 时存在，值为 1)
+}
+
+// 完成事件的 data（空对象）
+// eslint-disable-next-line @typescript-eslint/no-empty-object-type
+export interface CompleteData {}
+
+// 错误事件的 data
+export interface ErrorData {
+  m: string // message
+}
+
+// SSE 事件类型
+export type SSEEventType = 'ws' | 'ns' | 'ne' | 'tk' | 'ok' | 'err'
+
+// 事件类型映射（后端使用）
+export const EventTypeMap = {
+  workflow_start: 'ws',
+  node_start: 'ns',
+  node_end: 'ne',
+  token: 'tk',
+  complete: 'ok',
+  error: 'err',
+} as const
+
+// 反向映射（前端使用）
+export const EventTypeReverse = {
+  ws: 'workflow_start',
+  ns: 'node_start',
+  ne: 'node_end',
+  tk: 'token',
+  ok: 'complete',
+  err: 'error',
+} as const

package/workflow.types.ts

@@ -0,0 +1,189 @@
+// 数据类型定义
+export interface TextData {
+  type: 'text'
+  value: string
+}
+
+export interface ImageData {
+  type: 'image'
+  value: { url: string }
+}
+
+export type InputData = TextData | ImageData
+
+// 节点类型常量
+export const NodeType = {
+  START: 'start',
+  END: 'end',
+  DATA_TRANSFORM: 'data_transform',
+  LOOP: 'loop',
+  BRAIN: 'brain',
+  CONDITION: 'condition',
+  OCR: 'ocr',
+  IMAGE_TO_IMAGE: 'image_to_image',
+  IMAGE_TO_VIDEO: 'image_to_video',
+  MESSAGE: 'message',
+  BILLING: 'billing',
+} as const
+
+export type NodeType = (typeof NodeType)[keyof typeof NodeType]
+
+// 节点配置接口
+export interface NodeConfig {
+  name: string
+}
+
+// 开始节点配置
+export interface StartNodeConfig extends NodeConfig {
+  type: typeof NodeType.START
+}
+
+// 结束节点配置
+export interface EndNodeConfig extends NodeConfig {
+  type: typeof NodeType.END
+}
+
+// 数据转换节点配置
+export interface DataTransformNodeConfig extends NodeConfig {
+  type: typeof NodeType.DATA_TRANSFORM
+  script: string // JS代码片段，接收 context 参数（包含 variables 和 messages），返回对象用于更新 variables
+}
+
+// 循环节点配置
+export interface LoopNodeConfig extends NodeConfig {
+  type: typeof NodeType.LOOP
+  subWorkflowId: string // 子工作流的ID引用
+  /** 执行模式：串行（默认）或并行 */
+  executionMode?: 'sequential' | 'parallel'
+  /** 是否显示子工作流内部事件（token、节点状态等），默认 false */
+  showSubWorkflowEvents?: boolean
+}
+
+// 联网搜索配置（使用豆包内置搜索工具）
+export interface WebSearchConfig {
+  /** 是否启用联网搜索 */
+  enabled: boolean
+  /** 最大关键词数量（1-10，默认 3） */
+  maxKeyword?: number
+}
+
+// 智慧大脑节点配置
+export interface BrainNodeConfig extends NodeConfig {
+  type: typeof NodeType.BRAIN
+  systemMessage: string // 系统提示词
+  humanMessageScript?: string // 可选的用户消息脚本，接收 context 参数（包含 variables 和 messages），返回 string[] 用于构造 HumanMessage[]
+  /** 联网搜索配置 */
+  webSearch?: WebSearchConfig
+}
+
+// 条件判断节点配置
+export interface ConditionNodeConfig extends NodeConfig {
+  type: typeof NodeType.CONDITION
+  conditions: Array<{
+    id: string
+    name: string // 条件名称，如 "文本处理"、"图片处理"
+    script: string // 条件判断脚本，如 "context.variables.input === 'text'"
+    description?: string // 条件描述
+  }>
+}
+
+// OCR 节点配置
+export interface OCRNodeConfig extends NodeConfig {
+  type: typeof NodeType.OCR
+  script: string // JS代码片段，接收 context 参数（包含 variables、messages 和 ocr 方法），返回对象用于更新 variables
+}
+
+// 图生图节点配置
+export interface ImageToImageNodeConfig extends NodeConfig {
+  type: typeof NodeType.IMAGE_TO_IMAGE
+  prompt: string // 图生图的提示词
+  script: string // JS代码片段，接收 context 参数（包含 variables、messages 和 imageToImage 方法），返回对象用于更新 variables
+}
+
+// 图生视频节点配置
+export interface ImageToVideoNodeConfig extends NodeConfig {
+  type: typeof NodeType.IMAGE_TO_VIDEO
+  prompt: string // 图生视频的提示词
+  duration: number // 视频时长（秒），支持 5 或 10
+  script: string // JS代码片段，接收 context 参数（包含 variables、messages 和 imageToVideo 方法），返回对象用于更新 variables
+}
+
+// 消息节点配置
+export interface MessageNodeConfig extends NodeConfig {
+  type: typeof NodeType.MESSAGE
+  role?: 'user' | 'assistant' // 消息角色，默认 assistant
+  content: string // 消息内容，支持模板变量 {{variableName}}
+  images?: string // 可选：图片变量名，如 "imageUrls" 会从 variables.imageUrls 读取
+  videos?: string // 可选：视频变量名，如 "videoUrl" 会从 variables.videoUrl 读取
+}
+
+// 计费节点配置
+export interface BillingNodeConfig extends NodeConfig {
+  type: typeof NodeType.BILLING
+  script: string // JS 代码片段，接收 context 参数，返回 { tokenCount: number, artifactCount: number }
+}
+
+// 联合类型：所有节点配置
+export type AnyNodeConfig =
+  | StartNodeConfig
+  | EndNodeConfig
+  | DataTransformNodeConfig
+  | LoopNodeConfig
+  | BrainNodeConfig
+  | ConditionNodeConfig
+  | OCRNodeConfig
+  | ImageToImageNodeConfig
+  | ImageToVideoNodeConfig
+  | MessageNodeConfig
+  | BillingNodeConfig
+
+// 工作流边配置
+export interface WorkflowEdge {
+  id: string
+  source: string
+  target: string
+  sourceHandle?: string | null
+  targetHandle?: string | null
+  conditionId?: string // 条件判断节点的条件ID，用于标识走哪个分支
+}
+
+// 工作流节点配置
+export interface WorkflowNode {
+  id: string
+  type: NodeType
+  position: { x: number; y: number }
+  config: AnyNodeConfig
+}
+
+// 工作流配置 (分离配置和实体)
+export interface WorkflowConfig {
+  id: string
+  name: string
+  description: string
+  nodes: WorkflowNode[]
+  edges: WorkflowEdge[]
+}
+
+// 工作流实体 (包含数据库元数据)
+export interface Workflow extends WorkflowConfig {
+  createdAt: string
+  updatedAt: string
+}
+
+// 工作流执行输入的消息内容部件类型
+export type WorkflowMessagePart =
+  | { type: 'text'; text: string }
+  | { type: 'image'; url?: string; base64?: string }
+  | { type: 'file' | 'audio' | 'video'; url?: string }
+  | { type: 'document'; base64?: string; url?: string; filename: string; mimeType: string }
+
+// 工作流执行输入的消息类型（content 为数组，支持多模态内容）
+export interface WorkflowMessage {
+  content: WorkflowMessagePart[]
+}
+
+// 工作流执行输入参数类型
+export interface WorkflowExecutionInput {
+  messages?: WorkflowMessage[]
+  variables?: Record<string, unknown>
+}