探员: 读取 node_modules/@bpmnkit/core/AGENTS.md,则 node_modules/@bpmnkit/core/agent-cards/<bpmn|dmn|form>.md (~1k令牌)取而代之的是这个README.

@ bpmnkit/ 核心

TypeScript- first BPMN 2.0 SDK — 剖析、构建、布局和优化图表

网站 • 妇女 文档 • 妇女 GitHub 图像 • 妇女 更改日志

核心层. Semver at 1.0:没有大放送,没有突破. 见 产品级。 。 。 .

概览

@bpmnkit/core 是BPMN Kit的基础。 它给你一切与BPMN 2.0,DMN 1.3,和Camunda Form定义在纯TypeScript中的工作——没有XML摔跤,没有运行时间依赖.

Parse → Modify → Validate → Export

特征

• BPMN 2.0 (英语) 分析、创建和导出全Zeebe/Camunda 8扩展支持的流程图
• 流利构建器 API ——在程序上构建有效的进程,永远不要触摸原始 XML
• 杉山布局引擎 ——有清洁正交边缘路由的自动定位元素
• 电话1.3 决策表,包括感觉表达支持
• Camunda 表格定义 – 类型安全形式建构器
• 优化器 ——内置规则引擎以检测和自动固定反标
• 压缩格式 - 在AI/LLM工作流程中,70%的代号效率较低的JSON代表
• 连接器目录 全部Camunda 8 箱外连接器模板,经确定后应用(@bpmnkit/core/connectors(中文(简体) )
• 无依赖 ——以浏览器,节点.js,Deno,Bun,和边缘运行时间运行

安装

npm install @bpmnkit/core
pnpm add @bpmnkit/core

快速启动

从代码构建进程

每个元素都要 (id, options)。在网关外的分会与 .branch(),而不是通过手接接线流——构建者创造出序列流.

import { Bpmn } from "@bpmnkit/core"

const defs = Bpmn.createProcess("order-flow")
  .name("Order Flow")
  .startEvent("start", { name: "Order Received" })
  .serviceTask("validate", {
    name: "Validate Order",
    taskType: "order-validator",
    ioMapping: {
      inputs: [{ source: "=order", target: "order" }],
      outputs: [{ source: "=valid", target: "isValid" }],
    },
  })
  .exclusiveGateway("check", { name: "Order Valid?" })
  .branch("valid", (b) =>
    b
      .condition("=isValid = true")
      .serviceTask("fulfill", { name: "Fulfill Order", taskType: "fulfillment-service" })
      .endEvent("end", { name: "Order Complete" }),
  )
  .branch("invalid", (b) =>
    b.defaultFlow().endEvent("reject-end", { name: "Order Rejected" }),
  )
  .withAutoLayout()
  .build()

const xml = Bpmn.export(defs)

分进程、边界事件和多事件

这些是最常接触到和最常被猜测的构造,所以 确切的形状是值得描述的. subProcess 把身体当作一个 回调 (第二个论点)和备选案文三。 边界事件需要活动的ID 它附属于; withBoundary 从前面的活动中供给它.

import { Bpmn } from "@bpmnkit/core"

const defs = Bpmn.createProcess("fulfilment")
  .name("Fulfilment")
  .startEvent("start")

  // Sub-process: id, content callback, then options.
  // multiInstance runs the body once per item in the collection.
  .subProcess(
    "provision",
    (sub) => {
      sub
        .startEvent("p-start")
        .serviceTask("provision-line", { name: "Provision Line", taskType: "provision" })
        .endEvent("p-end")
    },
    {
      name: "Provision Each Line",
      multiInstance: { collection: "=order.lines", elementVariable: "line", isSequential: false },
    },
  )

  // withBoundary attaches to the activity just added — no id repeated.
  .serviceTask("charge", { name: "Charge Payment", taskType: "payment" })
  .withBoundary("charge-failed", { errorCode: "PAYMENT_FAILED" }, (b) => {
    b.serviceTask("retry-charge", { name: "Retry Charge", taskType: "payment" }).endEvent("gave-up")
  })

  // Wait for whichever event arrives first.
  .eventBasedGateway("await-payment", { name: "Paid?" })
  .branch("paid", (b) =>
    b
      .intermediateCatchEvent("payment-confirmed", {
        messageName: "PaymentConfirmed",
        correlationKey: "=orderId",
      })
      .endEvent("done"),
  )
  .branch("timeout", (b) =>
    b.intermediateCatchEvent("payment-timeout", { timerDuration: "P14D" }).endEvent("written-off"),
  )
  .withAutoLayout()
  .build()

在不是前项活动时明确附上边界事件——两者均 下面的表单被接受,一个没有主机抛出而不是 导出无法读取的 BPMN :

.boundaryEvent("timeout", { attachedTo: "charge", timerDuration: "PT30M" })
.boundaryEvent("timeout", "charge", { timerDuration: "PT30M" })

事件定义是命名选项,而不是嵌入对象—— timerDuration, (中文(简体) ), timerDate, (中文(简体) ), timerCycle, (中文(简体) ), messageName (与 correlationKey, (中文(简体) ), errorCode, (中文(简体) ), signalName, (中文(简体) ), compensation。构建者不选择 知道被悄悄放弃了 所以 timer: { duration: "P7D" } 生成边界 没有计时器的事件.

分析并修改现有的 BPMN

import { Bpmn } from "@bpmnkit/core"

const defs = Bpmn.parse(xml)
const process = defs.processes[0]

// Access flow elements
for (const el of process.flowElements) {
  console.log(el.type, el.id, el.name)
}

// Serialize back to XML
const updated = Bpmn.export(defs)

自动播放进程

import { applyAutoLayout, Bpmn } from "@bpmnkit/core"

// Lays out every process and writes the diagram interchange back onto the model.
const laid = Bpmn.export(applyAutoLayout(Bpmn.parse(xml)))

优化图表

import { Bpmn, optimize } from "@bpmnkit/core"

const defs = Bpmn.parse(xml)
const report = optimize(defs)

console.log(`${report.summary.total} findings`)

for (const finding of report.findings) {
  console.log(`[${finding.severity}] ${finding.message}`)
  if (finding.applyFix) {
    const { description } = finding.applyFix(defs)
    console.log("Fixed:", description)
  }
}

AI/LLM工作流程的压缩格式

import { Bpmn, compactify, expand } from "@bpmnkit/core"

// Shrink for AI prompt
const defs = Bpmn.parse(xml)
const compact = compactify(defs)          // ~70% smaller JSON
const json = JSON.stringify(compact)      // send to LLM

// Restore full BPMN from AI response
const restored = expand(JSON.parse(json))
const outXml = Bpmn.export(restored)

模型还在写的时候渲染

一个模型一次发出一个符号,最外层 } - 那个 JSON.parse 等待——是它发送的最后一个字符. createCompactStream 将文字中的元素读取为自己的文字相近,所以 在文档完成前很久要绘制的东西 :

import { createCompactStream } from "@bpmnkit/core"

// `base` is the diagram being edited, so a frame shows the whole thing rather
// than the fragment the model is adding to it. Omit it to build from nothing.
const diagramStream = createCompactStream({ base: null })

function onModelChunk(chunk: string): void {
  const frame = diagramStream.push(chunk) // null until the frame changes
  if (frame) console.log("elements so far:", frame.processes[0]?.flowElements.length)
}

框架是对未完成文档的猜测 : push 不扔,不丢 无法放置,并期望呼叫者有权威结果.

API 参考

不丹

进程构建器

每个元素方法都是 (id, options) 并返回建设者。 同样的方法 内有 .branch() 在一个子进程体内.

事件定义是该要素的选项: timerDuration, (中文(简体) ), timerDate, (中文(简体) ), timerCycle, (中文(简体) ), messageName + 键 correlationKey, (中文(简体) ), errorCode, (中文(简体) ), signalName, (中文(简体) ), compensation. 多方参与是 options.multiInstance = { collection, elementVariable, isSequential? }。 。 。 .

语义

输入代码生成

编辑

写入文件( E)@bpmnkit/core/node(中文(简体) )

import { writeBpmn } from "@bpmnkit/core/node"

// Refuses rather than overwrite; pass force: true to replace.
const { semanticHash, changes } = await writeBpmn(defs, { output: "flow.bpmn" })

连接器( E)@bpmnkit/core/connectors(中文(简体) )

Camunda 8 出盒连接器目录, 隐藏在它的子路径后面, 所以它的数据只是 被输入密码捆绑 模板将图标、组、工具提示和 占位符; @bpmnkit/connectors 增加这些回 对于一个财产面板.

import { applyConnectorTemplate } from "@bpmnkit/core/connectors"

const { serviceTask, problems } = applyConnectorTemplate("io.camunda.connectors.HttpJson.v2", {
  url: "https://api.example.com/orders",
})

丹麦

表单

布局优化( O)

流程文件

options 带 decisions (单位:千美元)DmnDefinitions[], (中文(简体) ), forms (单位:千美元)FormDefinition[], (中文(简体) ), title, (中文(简体) ), subtitle 财务报告和审定财务报表 diagram。输出是决定性的,所有模型文本都逃脱.

相关软件包

许可证

麻省理工学院 BPMN Kit—— 制片人: u11g (单位:千克)