Skip to content

自动生成

本文档由 pnpm run gen:executor-docs 生成,请勿手动编辑源文件外的副本。

BizApi 单节点试跑(与下文各节点 config 一一对应)

在不启动整条 Workflow 画布 时,可执行一个内置节点。自动执行助手优先用下列 command:

command用途
listAiExecutorTypesApi列出合法 executorType(= 下文节点 slug)
tryRunAiExecutorApi推荐:试跑单节点;返回 CommonResult,data{ success, output?, error? }
runNode同能力底层接口;args 为 [executorType, config, variables] 或三字段对象

tryRunAiExecutorApi 参数(executorConfig 权威来源 = 下文按 slug 展开的字段表)

json
{
  "executorType": "http-get",
  "executorConfig": {
    "url": "https://httpbin.org/get",
    "saveToVariable": "body"
  },
  "variables": { "body": "" }
}
  • executorType:与下文 ### \slug`标题一致(如delayhttp-postdingtalk-notify`),不是 WorkflowWorker 的 workerId。
  • executorConfig:即画布节点 config;字段名、必填项只能取自下文对应 slug 条目,禁止编造。
  • variables:注入节点执行上下文;节点写入的变量可在反馈 data.output 中读取。

术语区分(自动执行必守)

  • 节点执行器 type = executorType / 下文 slug → 用 tryRunAiExecutorApirunNode
  • 窗口 Workflow = workflowId → 用 startWorkflow / stopWorkflow 等。
  • WorkflowWorker = workerId → 用 *WorkflowWorker*table* 等 API。

节点 config 类型说明

说明

  • 下列按节点 slug(与工作流画布里的节点 type 一致)列出各节点的 config 字段:名称、必填/可选、类型文本与注释。
  • 若某节点条目中 confignull,表示类型定义不是内联对象,本表无法自动展开字段;以该条目的文字说明为准。

Schema 示例(单节点,delay

json
{
  "tsInterface": "DelayNodeDefinition",
  "description": "延时节点定义",
  "config": {
    "type": "object",
    "required": [
      "delayType"
    ],
    "properties": {
      "delayType": {
        "type": "string",
        "enum": [
          "fixed",
          "random"
        ],
        "description": "延迟类型:fixed-固定时间 random-随机时间"
      },
      "delayMs": {
        "type": "number",
        "description": "固定延迟时间(毫秒)"
      },
      "minDelayMs": {
        "type": "number",
        "description": "随机延迟最小时间(毫秒)"
      },
      "maxDelayMs": {
        "type": "number",
        "description": "随机延迟最大时间(毫秒)"
      }
    }
  }
}

ai-provider

AI Provider 对话节点定义(与 src/main/ai/providers 对齐)

TS 接口:AiProviderNodeDefinition

  • provider(必填) 'ollama' | 'deepseek' | 'cursor' — 渠道:ollama | deepseek | cursor
  • model(必填) string — 模型 ID
  • think(可选) boolean — 是否开启思考链
  • stream(可选) boolean — 是否流式(工作流建议关闭以聚合全文)
  • baseUrl(可选) string — 自定义 Base URL
  • apiKey(可选) string — API Key(可选,也可用环境变量)
  • systemPrompt(可选) string — 系统提示词
  • userPrompt(必填) string — 用户提示词
  • cursorUseLocalAgent(可选) boolean — Cursor:是否走本地 agent CLI
  • cursorWorkspace(可选) string — Cursor 本地 agent 的 --workspace 目录
  • timeout(可选) number — 超时毫秒,0 表示不限制
  • responseVariable(可选) string — 保存助手正文到变量
  • thinkingVariable(可选) string — 保存思考链文本到变量

android-adb-shell

TS 接口:AndroidAdbShellNodeDefinition

  • deviceId(可选) string
  • adbPath(可选) string
  • timeout(可选) number
  • command(必填) string
  • continueOnError(可选) boolean
  • stdoutVariable(可选) string
  • stderrVariable(可选) string
  • exitCodeVariable(可选) string

android-input-text

TS 接口:AndroidInputTextNodeDefinition

  • deviceId(可选) string
  • adbPath(可选) string
  • timeout(可选) number
  • text(必填) string

android-key-event

TS 接口:AndroidKeyEventNodeDefinition

  • deviceId(可选) string
  • adbPath(可选) string
  • timeout(可选) number
  • key(必填) string

android-list-devices

TS 接口:AndroidListDevicesNodeDefinition

  • adbPath(可选) string
  • timeout(可选) number
  • saveToVariable(必填) string

android-screenshot

TS 接口:AndroidScreenshotNodeDefinition

  • deviceId(可选) string
  • adbPath(可选) string
  • timeout(可选) number
  • savePath(必填) string
  • fileName(可选) string
  • saveToVariable(可选) string

android-start-app

TS 接口:AndroidStartAppNodeDefinition

  • deviceId(可选) string
  • adbPath(可选) string
  • timeout(可选) number
  • packageName(必填) string
  • activity(可选) string

android-swipe

TS 接口:AndroidSwipeNodeDefinition

  • deviceId(可选) string
  • adbPath(可选) string
  • timeout(可选) number
  • x1(必填) number
  • y1(必填) number
  • x2(必填) number
  • y2(必填) number
  • durationMs(可选) number

android-tap

TS 接口:AndroidTapNodeDefinition

  • deviceId(可选) string
  • adbPath(可选) string
  • timeout(可选) number
  • positionType(可选) 'coordinate' | 'image'
  • x(可选) number
  • y(可选) number
  • targetImage(可选) ResourceElement
  • tolerance(可选) number
  • continueOnNotFound(可选) boolean
  • longPressMs(可选) number

android-usb-forward

TS 接口:AndroidUsbForwardNodeDefinition

  • deviceId(可选) string
  • adbPath(可选) string
  • timeout(可选) number
  • action(必填) 'add' | 'remove' | 'list'
  • localSpec(可选) string
  • remoteSpec(可选) string
  • saveToVariable(可选) string

android-usb-install

TS 接口:AndroidUsbInstallNodeDefinition

  • deviceId(可选) string
  • adbPath(可选) string
  • timeout(可选) number
  • apkPath(必填) string
  • replace(可选) boolean

android-usb-pull

TS 接口:AndroidUsbPullNodeDefinition

  • deviceId(可选) string
  • adbPath(可选) string
  • timeout(可选) number
  • remotePath(必填) string
  • localPath(必填) string

android-usb-push

TS 接口:AndroidUsbPushNodeDefinition

  • deviceId(可选) string
  • adbPath(可选) string
  • timeout(可选) number
  • localPath(必填) string
  • remotePath(必填) string

android-usb-reconnect

TS 接口:AndroidUsbReconnectNodeDefinition

  • deviceId(可选) string
  • adbPath(可选) string
  • timeout(可选) number
  • mode(必填) 'device' | 'restart-server'

android-usb-uninstall

TS 接口:AndroidUsbUninstallNodeDefinition

  • deviceId(可选) string
  • adbPath(可选) string
  • timeout(可选) number
  • packageName(必填) string
  • keepData(可选) boolean

android-usb-wait

TS 接口:AndroidUsbWaitNodeDefinition

  • deviceId(可选) string
  • adbPath(可选) string
  • timeout(可选) number

array-op

数组操作节点定义

TS 接口:ArrayOpNodeDefinition

  • sourceArray(必填) string — 源数组变量
  • operation(必填) ArrayOperationType — 操作类型
  • index(可选) string — 索引(get/splice/insert/set时使用)
  • deleteCount(可选) number — 删除数量(splice时使用)
  • value(可选) string — 元素值(push/unshift/insert/set/includes时使用)
  • concatArray(可选) string — 合并数组(concat时使用)
  • startIndex(可选) string — 起始索引(slice时使用)
  • endIndex(可选) string — 结束索引(slice时使用)
  • flatDepth(可选) number — 扁平化深度(flat时使用)
  • separator(可选) string — 连接符(join时使用)
  • fieldPath(可选) string — 字段路径(pluck/groupBy时使用)
  • sortOrder(可选) 'asc' | 'desc' — 排序方式(sort时使用)
  • sortField(可选) string — 排序字段(sort时使用)
  • condition(可选) string — 条件表达式(filter/find/findIndex/every/some时使用)
  • mapExpression(可选) string — 映射表达式(map时使用)
  • reduceExpression(可选) string — 归约表达式(reduce时使用)
  • initialValue(可选) string — 初始值(reduce时使用)
  • randomCount(可选) string — 随机取数数量(random时使用,默认1)
  • saveToVariable(必填) string — 保存结果到变量

base64-decode

TS 接口:Base64DecodeNodeDefinition

  • inputSource(可选) 'text' | 'variable'
  • input(可选) string
  • sourceVariable(可选) string
  • encoding(可选) 'utf-8' | 'latin1' | 'ascii'
  • saveToVariable(必填) string

base64-encode

TS 接口:Base64EncodeNodeDefinition

  • inputSource(可选) 'text' | 'variable'
  • input(可选) string
  • sourceVariable(可选) string
  • saveToVariable(必填) string

clipboard-add-files

TS 接口:ClipboardAddFilesNodeDefinition

  • filePath(必填) string

clipboard-clear

TS 接口:ClipboardClearNodeDefinition

  • config(必填) 见 node-types.ts — config 非内联 TypeLiteral,请直接查看类型定义

clipboard-get-text

TS 接口:ClipboardGetTextNodeDefinition

  • saveToVariable(必填) string

clipboard-set

TS 接口:ClipboardSetNodeDefinition

  • content(必填) string

close-app

关闭应用节点定义

TS 接口:CloseAppNodeDefinition

  • closeType(必填) 'name' | 'process' | 'title' — 关闭方式
  • appName(可选) string — 应用名称
  • processName(可选) string — 进程名称
  • windowTitle(可选) string — 窗口标题
  • force(可选) boolean — 是否强制关闭
  • waitTimeout(可选) number — 等待关闭超时(毫秒)

close-browser-window

关闭窗口节点定义

TS 接口:CloseBrowserWindowNodeDefinition

  • workflowId(必填) string — 选择的窗口配置ID

condition

条件判断节点定义

TS 接口:ConditionNodeDefinition

  • conditionType(必填) ConditionType
  • condition(可选) string
  • conditionGroups(可选) ConditionGroup[]
  • groupsLogic(可选) LogicalOperator
  • trueNodeId(可选) string
  • falseNodeId(可选) string

copy-file

复制文件节点定义

TS 接口:CopyFileNodeDefinition

  • sourcePath(必填) string
  • destPath(必填) string
  • overwrite(可选) boolean

date-time

时间处理节点定义

TS 接口:DateTimeNodeDefinition

  • operation(必填) 'now' | 'format' | 'parse' | 'add' | 'diff' | 'compare' | 'get' | 'set' | 'startOf' | 'endOf' | 'timestamp' — 操作类型
  • input(可选) string — 输入时间
  • inputFormat(可选) string — 输入格式
  • outputFormat(可选) string — 输出格式
  • unit(可选) 'year' | 'month' | 'week' | 'day' | 'hour' | 'minute' | 'second' | 'millisecond' — 时间单位
  • value(可选) number | string — 数值(用于add/set操作)
  • compareTime(可选) string — 比较时间
  • compareType(可选) 'isBefore' | 'isAfter' | 'isSame' | 'isSameOrBefore' | 'isSameOrAfter' | 'isBetween' — 比较方式
  • endTime(可选) string — 结束时间(用于isBetween)
  • timestampType(可选) 'millisecond' | 'second' — 时间戳类型
  • saveToVariable(必填) string — 保存到变量

delay

延时节点定义

TS 接口:DelayNodeDefinition

  • delayType(必填) 'fixed' | 'random' — 延迟类型:fixed-固定时间 random-随机时间
  • delayMs(可选) number — 固定延迟时间(毫秒)
  • minDelayMs(可选) number — 随机延迟最小时间(毫秒)
  • maxDelayMs(可选) number — 随机延迟最大时间(毫秒)

delete-file

删除文件节点定义

TS 接口:DeleteFileNodeDefinition

  • filePath(必填) string — 文件路径

dingtalk-notify

钉钉推送节点定义

TS 接口:DingtalkNotifyNodeDefinition

  • accessToken(必填) string — 自定义机器人 Webhook 中的 access_token(不含 URL)
  • secret(可选) string — 加签密钥 SEC...(启用「加签」时填写)
  • msgtype(必填) 'text' | 'link' | 'markdown' | 'actionCard' | 'feedCard' — 消息类型
  • content(可选) string — 文本/Markdown 内容
  • title(可选) string — 标题(markdown/link/actionCard 使用)
  • linkUrl(可选) string — 链接 URL(link/actionCard 使用)
  • picUrl(可选) string — 图片 URL(link 使用)
  • linkText(可选) string — 链接描述(link 使用)
  • cardText(可选) string — ActionCard 正文
  • btnTitle(可选) string — 单按钮标题(actionCard 使用)
  • btnOrientation(可选) '0' | '1' — 按钮排列方向:0-竖直 1-水平
  • feedLinks(可选) string — FeedCard links JSON 字符串
  • atMobiles(可选) string
  • atUserIds(可选) string
  • atAll(可选) boolean — 是否
  • timeout(可选) number — 超时时间(ms)
  • saveToVariable(可选) string — 保存响应到变量

download-file

下载文件节点定义

TS 接口:DownloadFileNodeDefinition

  • url(必填) string — 下载URL
  • savePath(可选) string — 保存目录
  • fileName(可选) string — 文件名
  • overwrite(可选) boolean — 是否覆盖已存在文件
  • timeout(可选) number — 超时时间(毫秒)
  • headers(可选) string — 请求头(JSON字符串)
  • savePathToVariable(可选) string — 保存文件路径到变量

excel-batch-read

Excel分批读取节点定义

TS 接口:ExcelBatchReadNodeDefinition

  • workbookVar(必填) string — 工作簿变量
  • sheetName(可选) string — 工作表名称或索引
  • batchSize(必填) number — 批次大小
  • startRow(可选) number — 起始行
  • endRow(可选) number — 结束行
  • hasHeader(可选) boolean — 是否包含表头
  • saveToVariable(必填) string — 保存批次数据到变量
  • totalRowsVar(可选) string — 保存总行数到变量
  • batchIndexVar(可选) string — 保存当前批次索引到变量
  • hasMoreVar(可选) string — 保存是否还有更多数据到变量

excel-close

关闭Excel节点定义

TS 接口:ExcelCloseNodeDefinition

  • workbookVar(必填) string — 工作簿变量
  • saveBeforeClose(可选) boolean — 关闭前保存

excel-import-table

Excel导入表格节点定义

TS 接口:ExcelImportTableNodeDefinition

  • sourceType(必填) 'file' | 'variable' — 数据来源类型
  • filePath(可选) string — 文件路径
  • workbookVar(可选) string — 工作簿变量
  • sheetName(可选) string — 工作表名称或索引
  • tableCode(必填) string — 目标表格业务编码(数据集模块全局唯一 tableCode)
  • fieldMapping(可选) string — 字段映射 JSON
  • defaultValues(可选) string — 默认值 JSON
  • batchSize(可选) number — 批次大小
  • startRow(可选) number — 起始行
  • skipEmptyRows(可选) boolean — 跳过空行
  • clearBeforeImport(可选) boolean — 导入前清空表格
  • transformScript(可选) string — 数据转换脚本
  • saveCountToVariable(可选) string — 保存导入数量到变量

excel-open

打开Excel节点定义

TS 接口:ExcelOpenNodeDefinition

  • openType(必填) 'open' | 'create' — 操作类型
  • filePath(可选) string — 文件路径
  • newFilePath(可选) string — 新文件路径
  • workbookVar(必填) string — 工作簿变量名

excel-read

读取Excel节点定义

TS 接口:ExcelReadNodeDefinition

  • workbookVar(必填) string — 工作簿变量
  • sheetName(可选) string — 工作表名称或索引
  • readType(必填) 'cell' | 'range' | 'sheet' — 读取方式
  • cellAddress(可选) string — 单元格地址
  • rangeAddress(可选) string — 范围地址
  • saveToVariable(必填) string — 保存到变量

excel-save

保存Excel节点定义

TS 接口:ExcelSaveNodeDefinition

  • workbookVar(必填) string — 工作簿变量
  • saveAs(可选) boolean — 是否另存为
  • newFilePath(可选) string — 新文件路径

excel-write

写入Excel节点定义

TS 接口:ExcelWriteNodeDefinition

  • workbookVar(必填) string — 工作簿变量
  • sheetName(可选) string — 工作表名称或索引
  • writeType(必填) 'cell' | 'range' — 写入方式
  • cellAddress(可选) string — 单元格地址
  • startCell(可选) string — 起始单元格
  • value(必填) string — 写入值

execute-in-window

窗口执行代码节点定义

TS 接口:ExecuteInWindowNodeDefinition

  • workflowId(必填) string — 选择的窗口配置ID
  • targetUrl(可选) string — 目标URL,可选,指定在哪个iframe中执行
  • code(必填) string — 要执行的JavaScript代码 脚本需要 return 进行返回参数,支持顶头await 异步返回
  • saveResultToVariable(可选) string — 保存结果到变量
  • waitForResult(可选) boolean — 是否等待执行完成
  • sandbox(可选) boolean — 是否使用沙箱模式,默认true(使用executeInWindow),false时使用getResponseById
  • timeout(可选) number — 超时时间(秒),仅直接执行模式(getResponseById)生效,默认 30
  • autoFocus(可选) boolean — 执行前是否显示并聚焦窗口,默认 false

find-image

图像查找节点定义

TS 接口:FindImageNodeDefinition

  • searchScope(必填) 'fullscreen' | 'region' | 'variable' — 查找范围: fullscreen-全屏, region-指定区域, variable-从变量图像
  • targetImage(必填) ResourceElement — 目标图像
  • tolerance(可选) number — 匹配精度 0.5-1.0
  • findAll(可选) boolean — 是否查找所有匹配
  • regionX(可选) number — 区域X坐标
  • regionY(可选) number — 区域Y坐标
  • regionWidth(可选) number — 区域宽度
  • regionHeight(可选) number — 区域高度
  • sourceVariable(可选) string — 源图像变量
  • saveToVariable(可选) string — 保存结果到变量
  • continueOnNotFound(可选) boolean — 未找到时继续执行

get-window-list

获取窗口列表节点定义

TS 接口:GetWindowListNodeDefinition

  • listScope(可选) 'running' | 'all' | 'enabled' | 'disabled' — 列表范围:running-正在运行 all-全部 enabled-启用 disabled-禁用
  • saveToVariable(必填) string — 保存窗口列表到变量

get-window-url

获取窗口URL节点定义

TS 接口:GetWindowUrlNodeDefinition

  • workflowId(必填) string — 选择的窗口配置ID
  • urlType(必填) 'main' | 'iframes' | 'all' — 获取类型: main-仅主窗口, iframes-仅iframe, all-全部
  • saveUrlToVariable(必填) string — 保存URL到变量

git-op

Git 操作节点定义

TS 接口:GitOpNodeDefinition

  • operation(必填) GitOperationType — 操作类型
  • cwd(可选) string — 工作目录(Git 仓库所在路径)
  • repoUrl(可选) string — 仓库 URL(clone 时使用)
  • cloneDir(可选) string — clone 后的目录名
  • branch(可选) string — 分支名称
  • remote(可选) string — 远程名称,默认 origin
  • files(可选) string — 操作文件路径(add/checkout/reset 使用,多文件以空格分隔)
  • message(可选) string — 提交信息(commit 使用)
  • autoAdd(可选) boolean — 提交前是否自动 add
  • logCount(可选) number — 日志条数(log 使用)
  • branchAction(可选) 'list' | 'create' | 'delete' | 'rename' — 分支管理子操作
  • force(可选) boolean — 是否使用 --force
  • customCommand(可选) string — 自定义命令(operation=custom 时使用)
  • extraArgs(可选) string — 附加参数(追加到命令末尾)
  • timeout(可选) number — 超时时间(ms)
  • saveToVariable(可选) string — 保存命令输出到变量

http-get

HTTP GET请求节点定义

TS 接口:HttpGetNodeDefinition

  • url(必填) string — 请求URL
  • timeout(可选) number — 超时时间(毫秒)
  • responseType(可选) 'json' | 'text' | 'arraybuffer' — 响应类型
  • headers(可选) string — 请求头(JSON字符串)
  • params(可选) string — 查询参数(JSON字符串)
  • saveToVariable(可选) string — 保存结果到变量

http-post

HTTP POST请求节点定义

TS 接口:HttpPostNodeDefinition

  • url(必填) string — 请求URL
  • contentType(可选) 'json' | 'form' | 'multipart' | 'text' — 内容类型
  • body(可选) string — 请求体
  • timeout(可选) number — 超时时间(毫秒)
  • responseType(可选) 'json' | 'text' | 'arraybuffer' — 响应类型
  • headers(可选) string — 请求头(JSON字符串)
  • saveToVariable(可选) string — 保存结果到变量

json-parse

JSON解析节点定义

TS 接口:JsonParseNodeDefinition

  • operation(必填) 'parse' | 'stringify' | 'extract' | 'modify' — 操作类型
  • input(必填) string — 输入数据
  • path(可选) string — 属性路径
  • newValue(可选) string — 新值
  • pretty(可选) boolean — 格式化输出
  • saveToVariable(必填) string — 保存到变量

keyboard-input

键盘输入节点定义

TS 接口:KeyboardInputNodeDefinition

  • type(必填) 'single' | 'multiple'
  • inputType(必填) 'text' | 'hotkey' | 'keypress'
  • text(可选) string
  • hotkey(可选) string
  • key(可选) string
  • modifiers(可选) string[]
  • wpm(可选) number
  • clearBeforeInput(可选) boolean
  • items(可选) KeyboardInputItem[]

log

日志输出节点定义

TS 接口:LogNodeDefinition

  • message(必填) string
  • level(必填) 'info' | 'warn' | 'error' | 'debug'

loop

循环节点定义

TS 接口:LoopNodeDefinition

  • loopType(必填) 'for' | 'while'
  • deleteVariableAfterLoop(可选) boolean — 循环结束后是否删除循环变量
  • arrayName(必填) string
  • indexVar(必填) string
  • itemVar(可选) string
  • conditionType(可选) 'expression' | 'variable'
  • condition(可选) string
  • conditionGroups(可选) ConditionGroup[]
  • groupsLogic(可选) LogicalOperator

mouse-click

鼠标点击节点定义

TS 接口:MouseClickNodeDefinition

  • clickType(必填) 'single' | 'double' | 'right'
  • positionType(必填) 'coordinate' | 'element'
  • x(必填) number
  • y(必填) number
  • delayMs(必填) number
  • element(可选) ResourceElement

mouse-move

鼠标移动节点定义

TS 接口:MouseMoveNodeDefinition

  • moveType(必填) 'absolute' | 'relative' | 'element'
  • x(必填) number
  • y(必填) number
  • smooth(必填) boolean
  • durationMs(必填) number
  • selector(可选) string

mouse-scroll

鼠标滚动节点定义

TS 接口:MouseScrollNodeDefinition

  • direction(必填) 'up' | 'down' | 'left' | 'right' — 滚动方向
  • amount(可选) number — 滚动量(像素或行数)
  • times(可选) number — 滚动次数
  • interval(可选) number — 滚动间隔(毫秒)
  • positionType(可选) 'current' | 'coordinate' | 'element' — 定位方式
  • x(可选) number — X坐标
  • y(可选) number — Y坐标
  • element(可选) ResourceElement — 目标元素

move-file

移动文件节点定义

TS 接口:MoveFileNodeDefinition

  • sourcePath(必填) string
  • destPath(必填) string
  • overwrite(可选) boolean

ocr

OCR识别节点定义

TS 接口:OcrNodeDefinition

  • sourceType(必填) 'screenshot' | 'region' | 'variable' | 'file' — 识别来源: screenshot-屏幕截图, region-指定区域, variable-从变量图像, file-从文件
  • language(可选) 'auto' | 'zh-Hans' | 'zh-Hant' | 'en' | 'ja' | 'ko' — 识别语言
  • recognitionLevel(可选) 'fast' | 'accurate' — 识别级别
  • x(可选) number — 区域X坐标
  • y(可选) number — 区域Y坐标
  • width(可选) number — 区域宽度
  • height(可选) number — 区域高度
  • sourceVariable(可选) string — 源图像变量
  • filePath(可选) string — 图像文件路径
  • saveTextToVariable(可选) string — 保存文本到变量
  • saveDetailToVariable(可选) string — 保存详细结果到变量

open-app

打开应用节点定义

TS 接口:OpenAppNodeDefinition

  • appName(必填) string
  • appPath(必填) string
  • args(必填) string
  • waitForStart(必填) boolean
  • timeout(必填) number

open-browser-window

打开浏览器窗口节点定义

TS 接口:OpenBrowserWindowNodeDefinition

  • workflowId(可选) string — 关联的工作流ID,用于获取基础配置
  • name(可选) string — 窗口名称
  • host(可选) string — 窗口加载的URL地址
  • preload(可选) string — 预加载脚本路径
  • preloadCode(可选) string — 预加载代码
  • json(可选) string — 窗口配置JSON,参考 WorkflowDataI

read-file

读取文件节点定义

TS 接口:ReadFileNodeDefinition

  • filePath(必填) string — 文件路径
  • encoding(可选) string — 编码格式
  • saveToVariable(可选) string — 保存到变量

regex

正则匹配节点定义

TS 接口:RegexNodeDefinition

  • operation(必填) 'test' | 'match' | 'matchAll' | 'replace' | 'split' — 操作类型
  • input(必填) string — 输入文本
  • pattern(必填) string — 正则表达式
  • flags(可选) string — 修饰符
  • replacement(可选) string — 替换文本
  • saveToVariable(必填) string — 保存到变量

rename-file

重命名文件节点定义

TS 接口:RenameFileNodeDefinition

  • sourcePath(必填) string
  • renameMode(可选) 'targetPath' | 'newName' | 'template'
  • targetPath(可选) string
  • newName(可选) string
  • renameTemplate(可选) string
  • overwrite(可选) boolean

run-script

代码脚本节点定义

TS 接口:RunScriptNodeDefinition

  • sourceType(可选) 'inline' | 'file' — 脚本来源: inline-内联代码, file-脚本文件
  • scriptPath(可选) string — 脚本文件路径
  • code(可选) string — 脚本代码
  • saveToVariable(可选) string — 保存结果到变量
  • timeout(可选) number — 超时时间(毫秒)

screenshot

屏幕截图节点定义

TS 接口:ScreenshotNodeDefinition

  • captureType(必填) 'fullscreen' | 'region' | 'interactive' — 截图方式: fullscreen-全屏, region-指定区域, interactive-交互式框选
  • screenIndex(可选) number — 屏幕索引
  • x(可选) number — 区域X坐标
  • y(可选) number — 区域Y坐标
  • width(可选) number — 区域宽度
  • height(可选) number — 区域高度
  • saveToFile(可选) boolean — 是否保存到文件
  • savePath(可选) string — 保存路径
  • fileName(可选) string — 文件名
  • saveToVariable(可选) string — 保存Base64到变量

set-var

设置变量节点定义

TS 接口:SetVarNodeDefinition

  • operation(必填) 'set' | 'delete' | 'array' | 'object' | 'boolean' | 'extract' | 'string' — 操作类型
  • variableName(必填) string — 变量名
  • value(可选) string — 变量值
  • valueType(可选) 'string' | 'number' | 'boolean' | 'json' | 'array' — 值类型
  • arrayOperation(可选) 'push' | 'pop' | 'shift' | 'unshift' | 'splice' | 'removeByValue' | 'clear' | 'concat' | 'filter' | 'map' — 数组操作类型
  • arrayValue(可选) string — 数组操作值
  • arrayIndex(可选) number — 数组索引
  • arrayExpression(可选) string — 数组表达式
  • objectOperation(可选) 'setProperty' | 'deleteProperty' | 'merge' | 'getProperty' | 'keys' | 'values' — 对象操作类型
  • propertyPath(可选) string — 属性路径
  • propertyValue(可选) string — 属性值
  • mergeObject(可选) string — 合并对象
  • resultVariable(可选) string — 结果变量
  • booleanOperation(可选) 'setTrue' | 'setFalse' | 'toggle' — 布尔操作类型
  • extractOperation(可选) 'byIndex' | 'byPath' — 取值操作类型
  • sourceVariable(可选) string — 源变量名
  • extractIndex(可选) number — 取值索引
  • extractPath(可选) string — 取值路径(lodash.get格式)
  • defaultValue(可选) string — 默认值
  • stringOperation(可选) | 'concat' | 'substring' | 'replace' | 'split' | 'toUpperCase' | 'toLowerCase' | 'trim' | 'length' | 'indexOf' | 'includes' | 'template' — 字符串操作类型
  • stringInput(可选) string — 输入字符串
  • concatText(可选) string — 拼接文本
  • startIndex(可选) number — 起始索引
  • endIndex(可选) number — 结束索引
  • searchText(可选) string — 查找文本
  • replaceText(可选) string — 替换文本
  • separator(可选) string — 分隔符
  • template(可选) string — 模板字符串

shell-exec

系统命令执行节点定义

TS 接口:ShellExecNodeDefinition

  • command(必填) string — 要执行的命令
  • mode(可选) 'shell' | 'spawn' — 执行模式:shell-经过 shell 解析;spawn-直接执行
  • cwd(可选) string — 工作目录
  • env(可选) Record<string, string> — 追加环境变量
  • stdin(可选) string — 标准输入内容
  • encoding(可选) string — 输出编码
  • timeout(可选) number — 超时时间(ms),0 表示不限制
  • continueOnError(可选) boolean — 失败时是否继续执行后续节点
  • stdoutVariable(可选) string — 保存 stdout 到变量
  • stderrVariable(可选) string — 保存 stderr 到变量
  • exitCodeVariable(可选) string — 保存退出码到变量

string-op

字符串处理节点定义

TS 接口:StringOpNodeDefinition

  • operation(必填) | 'concat' | 'substring' | 'replace' | 'split' | 'toUpperCase' | 'toLowerCase' | 'trim' | 'pad' | 'repeat' | 'length' | 'indexOf' | 'includes' | 'startsWith' | 'endsWith' | 'template' | 'regexExtract' — 操作类型
  • input(必填) string — 输入文本
  • concatText(可选) string — 拼接文本
  • startIndex(可选) number — 起始位置
  • endIndex(可选) number — 结束位置
  • searchText(可选) string — 查找文本
  • replaceText(可选) string — 替换文本
  • searchIsRegex(可选) boolean — 查找文本按正则解析(仅 replace 操作生效,使用 regexFlags 作为修饰符,replaceText 支持 $1/$& 等捕获引用)
  • separator(可选) string — 分隔符
  • separatorIsRegex(可选) boolean — 分隔符按正则解析(仅 split 操作生效,使用 regexFlags 作为修饰符)
  • padChar(可选) string — 填充字符
  • targetLength(可选) number — 目标长度
  • padDirection(可选) 'start' | 'end' — 填充方向
  • repeatCount(可选) number — 重复次数
  • template(可选) string — 模板字符串
  • regexPattern(可选) string — 正则提取用的模式(operation 为 regexExtract 时必填)
  • regexFlags(可选) string — 正则修饰符;提取首段匹配时会忽略 g,避免 match 行为与捕获组不一致
  • regexGroupIndex(可选) number — 捕获组下标:0 为整段匹配,1 为第一组,以此类推
  • saveToVariable(必填) string — 保存到变量

switch

Switch节点定义

TS 接口:SwitchNodeDefinition

  • cases(必填) SwitchCase[] — 分支列表

table-op

表格操作节点定义

TS 接口:TableOpNodeDefinition

  • operation(必填) 'insert' | 'batchInsert' | 'find' | 'findOne' | 'update' | 'delete' | 'count' | 'clear' — 操作类型
  • tableCode(必填) string — 表格业务编码(数据集模块全局唯一 tableCode)
  • data(可选) string — 数据(JSON)
  • criteria(可选) string — 查询条件(JSON)
  • saveToVariable(可选) string — 保存结果到变量

terminate-workflow

TS 接口:TerminateWorkflowNodeDefinition

  • message(可选) string

trigger

触发器节点定义

TS 接口:TriggerNodeDefinition

  • triggerType(必填) 'manual' | 'cron' | 'interval' — 触发方式
  • cronExpression(可选) string — Cron表达式
  • intervalMs(可选) number — 间隔时间(毫秒)
  • enabled(可选) boolean — 是否启用
  • description(可选) string — 描述

unzip-file

ZIP解压节点定义

TS 接口:UnzipFileNodeDefinition

  • inputType(必填) 'file' | 'folder' | 'glob' — 输入类型: file-单个文件, folder-文件夹, glob-Glob模式
  • sourcePath(可选) string — ZIP文件路径(inputType为file时使用)
  • sourceFolder(可选) string — 源文件夹(inputType为folder时使用)
  • globPattern(可选) string — Glob模式(inputType为glob时使用)
  • destPath(必填) string — 目标文件夹
  • overwrite(可选) boolean — 是否覆盖已存在文件
  • createSubFolder(可选) boolean — 是否为每个ZIP创建子文件夹
  • renameToArchiveName(可选) boolean — 按压缩包名重命名解压文件
  • deleteSourceArchive(可选) boolean — 解压后删除源压缩包
  • saveToVariable(可选) string — 保存解压路径到变量

wait-element

等待元素节点定义

TS 接口:WaitElementNodeDefinition

  • waitType(必填) 'appear' | 'disappear' | 'clickable' — 等待条件
  • element(必填) ResourceElement — 目标元素
  • timeout(可选) number — 超时时间(毫秒)
  • interval(可选) number — 检查间隔(毫秒)
  • continueOnTimeout(可选) boolean — 超时后继续执行

wait-file

TS 接口:WaitFileNodeDefinition

  • waitType(可选) 'appear' | 'disappear'
  • filePath(必填) string
  • timeout(可选) number
  • interval(可选) number
  • continueOnTimeout(可选) boolean

wait-window

等待窗口节点定义

TS 接口:WaitWindowNodeDefinition

  • waitType(必填) 'appear' | 'disappear' | 'active' — 等待条件
  • matchType(必填) 'title-exact' | 'title-contains' | 'title-regex' | 'process' — 匹配方式
  • matchValue(必填) string — 匹配值
  • timeout(可选) number — 超时时间(毫秒)
  • interval(可选) number — 检查间隔(毫秒)
  • continueOnTimeout(可选) boolean — 超时后继续执行

获取窗口Cookie节点定义

TS 接口:WindowCookieNodeDefinition

  • workflowId(必填) string — 窗口配置ID
  • getType(必填) 'all' | 'byName' | 'byUrl' — 获取方式
  • cookieName(可选) string — Cookie名称(byName时使用)
  • url(可选) string — URL(byUrl时使用)
  • outputFormat(可选) 'object' | 'array' | 'string' — 输出格式
  • saveToVariable(必填) string — 保存到变量

window-element-exists

窗口元素存在检测节点定义

TS 接口:WindowElementExistsNodeDefinition

  • workflowId(必填) string — 窗口配置ID
  • targetUrl(可选) string — 目标URL(用于定位iframe)
  • findBy(可选) 'cssSelector' | 'xpath' — 选择器类型
  • selector(必填) string — 选择器
  • tryCount(可选) number — 重试次数
  • timeout(可选) number — 重试间隔(ms)
  • saveToVariable(可选) string — 保存结果到变量

window-element-scroll

窗口元素滚动节点定义

TS 接口:WindowElementScrollNodeDefinition

  • workflowId(必填) string — 窗口配置ID
  • targetUrl(可选) string — 目标URL(用于定位iframe)
  • findBy(可选) 'cssSelector' | 'xpath' — 选择器类型
  • selector(必填) string — 选择器
  • smooth(可选) boolean — 是否平滑滚动
  • scrollIntoView(可选) boolean — 是否滚动到视图
  • scrollX(可选) number — 水平滚动位置
  • scrollY(可选) number — 垂直滚动位置
  • incX(可选) boolean — 是否增量X滚动
  • incY(可选) boolean — 是否增量Y滚动

window-event-click

窗口模拟点击节点定义

TS 接口:WindowEventClickNodeDefinition

  • workflowId(必填) string — 窗口配置ID
  • targetUrl(可选) string — 目标URL(用于定位iframe)
  • findBy(可选) 'cssSelector' | 'xpath' — 选择器类型
  • selector(必填) string — 选择器
  • waitForSelector(可选) boolean — 是否等待选择器
  • waitSelectorTimeout(可选) number — 等待超时时间(ms)

window-forms

窗口表单操作节点定义

TS 接口:WindowFormsNodeDefinition

  • workflowId(必填) string — 窗口配置ID
  • targetUrl(可选) string — 目标URL(用于定位iframe)
  • findBy(可选) 'cssSelector' | 'xpath' — 选择器类型
  • selector(必填) string — 选择器
  • actionType(可选) 'setValue' | 'getValue' — 操作类型
  • formType(可选) 'text-field' | 'select' | 'checkbox' | 'radio' — 表单类型
  • value(可选) string — 表单值
  • clearValue(可选) boolean — 是否清除值
  • delay(可选) number — 输入延迟(ms)
  • saveToVariable(可选) string — 保存结果到变量

window-http

窗口HTTP请求节点定义

TS 接口:WindowHttpNodeDefinition

  • workflowId(必填) string — 窗口配置ID
  • targetUrl(可选) string — 目标URL(用于定位iframe)
  • url(必填) string — 请求URL
  • method(可选) 'GET' | 'POST' | 'PUT' | 'DELETE' | 'PATCH' — 请求方法
  • headers(可选) Record<string, string> — 请求头
  • body(可选) string — 请求体
  • responseType(可选) 'json' | 'text' | 'blob' | 'buffer' — 响应类型
  • timeout(可选) number — 超时时间(ms)
  • sleep(可选) number — 请求前延迟(ms)
  • saveToVariable(可选) string — 保存结果到变量

window-load-url

窗口加载 URL 节点定义(主窗口 webContents 导航)

TS 接口:WindowLoadUrlNodeDefinition

  • workflowId(必填) string — 窗口配置 ID(workflowId)
  • url(必填) string — 要加载的完整 URL

write-file

写入文件节点定义

TS 接口:WriteFileNodeDefinition

  • filePath(必填) string — 文件路径
  • content(必填) string — 文件内容
  • encoding(可选) string — 编码格式
  • append(可选) boolean — 是否追加

zip-file

ZIP压缩节点定义

TS 接口:ZipFileNodeDefinition

  • inputType(必填) 'file' | 'folder' | 'glob'
  • sourcePath(可选) string
  • sourceFolder(可选) string
  • globPattern(可选) string
  • destPath(必填) string
  • overwrite(可选) boolean
  • saveToVariable(可选) string

企业级桌面 RPA 自动化平台