@frontera-sdk/workflow 1.50.62-next.0

package/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2026 Sebati
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,150 @@
+# @frontera-sdk/workflow
+
+A typed, headless client for Frontera workflows. From a script or a backend it
+authors and publishes a definition, starts runs, reads the run tree, waits for a
+run to settle, and manages versions and agent access. No React, no UI.
+
+```bash
+bun add @frontera-sdk/workflow @frontera-sdk/core
+```
+
+## Credential
+
+Use a workspace key (`sk-ws-…`). Workflows are closed to organization keys, and
+no capability on an organization key opens them. A call made with one fails
+with a `FronteraError` whose `code` is `FORBIDDEN` and whose message says so.
+
+## Run a workflow
+
+```ts
+import { FronteraClient } from '@frontera-sdk/core/client'
+import { FronteraError } from '@frontera-sdk/core/errors'
+import { WorkflowClient } from '@frontera-sdk/workflow/workflow-client'
+
+const client = new FronteraClient({
+  apiBaseUrl: 'https://api.acme.example',
+  credential: { kind: 'apiKey', key: process.env.FRONTERA_WORKSPACE_KEY! },
+})
+const workflows = new WorkflowClient(client)
+
+const { runId } = await workflows.run('supplier-onboarding', {
+  input: { supplierId: 'S-1042' },
+})
+
+const run = await workflows.waitForRun(runId, { timeoutMs: 5 * 60_000 })
+console.log(run.status, run.output)
+```
+
+`waitForRun` polls every 1.5 seconds by default and resolves once the run is
+`succeeded`, `failed` or `canceled`. On timeout it throws a `FronteraError` with
+code `RUN_WAIT_TIMEOUT` and leaves the run alone.
+
+### Cancel
+
+```ts
+const controller = new AbortController()
+setTimeout(() => controller.abort(), 30_000)
+
+try {
+  await workflows.waitForRun(runId, { signal: controller.signal })
+} catch (err) {
+  if (err instanceof FronteraError && err.code === 'ABORTED') {
+    const { status } = await workflows.cancel(runId)
+    console.log('cancelled, run is now', status)
+  } else {
+    throw err
+  }
+}
+```
+
+A run that had already finished comes back from `cancel` with the status it
+reached, not `canceled`.
+
+### File inputs
+
+Put a `File` in `input` and the request goes as multipart, with each file as its
+own part. Nothing else changes.
+
+```ts
+await workflows.run('supplier-onboarding', {
+  input: { supplierId: 'S-1042', contract: new File([bytes], 'contract.pdf') },
+})
+```
+
+## Author a workflow
+
+A definition is a plain object typed as `WorkflowDefinition`, so the step kinds,
+their parameters and the trigger forms are checked as you write them.
+
+```ts
+import type { WorkflowDefinition } from '@frontera-sdk/workflow/definition'
+
+const definition: WorkflowDefinition = {
+  apiVersion: 'workflow/v1',
+  name: 'supplier-onboarding',
+  trigger: [{ kind: 'manual' }],
+  nodes: [
+    { id: 'score', kind: 'function', params: { slug: 'score-supplier' } },
+  ],
+}
+
+const check = await workflows.push('supplier-onboarding', definition, { dryRun: true })
+if (!check.ok) throw new Error(check.errors?.join('\n'))
+
+const published = await workflows.push('supplier-onboarding', definition)
+await workflows.promote('supplier-onboarding', published.version!.number)
+```
+
+A dry run validates and writes nothing, reporting every problem at once as
+`ok: false` with `errors`. It also returns `grants`, the set of resources the
+server derived from the definition. A slug that does not exist is created by the
+first push.
+
+The type describes the document after the server applies its defaults, so a
+field with a default reads as required.
+
+### Iterate on a draft
+
+```ts
+await workflows.overwriteDraft('supplier-onboarding', number, definition)
+const result = await workflows.testNode('supplier-onboarding', number, 'score')
+```
+
+`overwriteDraft` rewrites a draft in place instead of stacking a version per
+edit. `testNode` runs one step. `copyVersion` opens a published version as a new
+draft, `deleteVersion` discards one.
+
+## Read the run tree
+
+`runById(runId)` and `waitForRun` return a `RunTree`. `RunTree.nodes[]` has one
+entry per executed step with its `status`, `input`, `output`, `error` and the
+ids of any Function run, Action request, conversation or child run it produced.
+Pass `depth: 'all'` to have those expanded inline, child runs included, so a
+renderer needs no further request.
+
+```ts
+const run = await workflows.runById(runId, 'all')
+for (const node of run.nodes) console.log(node.nodeId, node.status)
+```
+
+## Page through run history
+
+`runs(slug, filters)` returns the newest rows first. Pass
+`before: runCursor(lastRow)` to fetch the page after the one you have.
+`workspaceRuns(filters)` does the same across every workflow in the workspace.
+
+## Entry points
+
+| Import | What it is |
+|---|---|
+| `@frontera-sdk/workflow/workflow-client` | `WorkflowClient` |
+| `@frontera-sdk/workflow/definition` | `WorkflowDefinition` and the step and trigger types |
+| `@frontera-sdk/workflow/types` | request and response types, `runCursor`, `isTerminalRunStatus` |
+
+`@frontera-sdk/workflow/definition` is the same model the engine validates
+against; the service reads these types back from this package, and a drift
+between them fails its typecheck.
+
+## License
+
+Apache-2.0. See [LICENSE](./LICENSE).

package/package.json

@@ -0,0 +1,48 @@
+{
+  "name": "@frontera-sdk/workflow",
+  "version": "1.50.62-next.0",
+  "description": "Typed headless client for starting, inspecting, waiting on and cancelling Frontera workflow runs from a script or backend.",
+  "keywords": [
+    "frontera",
+    "workflow",
+    "sdk"
+  ],
+  "license": "Apache-2.0",
+  "type": "module",
+  "files": [
+    "src",
+    "!src/__tests__",
+    "!src/**/*.test.ts",
+    "README.md",
+    "LICENSE"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "exports": {
+    "./definition": {
+      "types": "./src/definition.ts",
+      "import": "./src/definition.ts"
+    },
+    "./types": {
+      "types": "./src/types.ts",
+      "import": "./src/types.ts"
+    },
+    "./workflow-client": {
+      "types": "./src/workflow-client.ts",
+      "import": "./src/workflow-client.ts"
+    }
+  },
+  "scripts": {
+    "test": "bun test",
+    "typecheck": "bunx tsc --noEmit"
+  },
+  "dependencies": {
+    "@frontera-sdk/core": "1.50.62",
+    "@frontera-sdk/functions": "1.50.62"
+  },
+  "devDependencies": {
+    "@types/bun": "^1.3.14",
+    "typescript": "^5.9.3"
+  }
+}

package/src/definition.ts

@@ -0,0 +1,297 @@
+/**
+ * The workflow definition: the authored artifact, as types.
+ *
+ * This is the shape a script author writes and pushes. It is types only — the
+ * platform still validates a pushed definition (shape, then lookups: does this
+ * `resourceId` exist, is this model enabled, does `$steps.risk` name an earlier
+ * node), and this file deliberately carries none of that. What it buys is the
+ * compile check and the autocomplete, so a mistake shows up in the editor
+ * instead of in a `dryRun` round trip.
+ *
+ * Every node is three layers: identity (`id`, `kind`, `resourceId?`, `label?`),
+ * `params` discriminated by `kind` (and, inside `blueprint`, by `mode`), and
+ * the shared settings every kind accepts.
+ *
+ * The node set is closed. All fourteen kinds are describable here, so a
+ * definition written for a later phase is refused by the engine as "not yet
+ * runnable", never as "unknown kind".
+ *
+ * These types describe the definition as the engine reads it, after the
+ * platform has applied documented defaults (`trigger.path`, `respond.status`,
+ * `stop.status` and friends). A field that has a default is written required
+ * here; the server fills it if the pushed document omits it.
+ */
+
+export const WORKFLOW_API_VERSION = 'workflow/v1'
+
+export const NODE_KINDS = [
+  'blueprint',
+  'function',
+  'llm',
+  'action',
+  'agent',
+  'plugin',
+  'http',
+  'transform',
+  'branch',
+  'forEach',
+  'parallel',
+  'wait',
+  'stop',
+  'respond',
+] as const
+export type NodeKind = (typeof NODE_KINDS)[number]
+
+/** A data input inside `params`: a literal, or a JSONata expression evaluated per run. */
+export type DataInput = { type: 'static'; value: unknown } | { type: 'expr'; expr: string }
+
+// ─── Triggers ────────────────────────────────────────────────────────────────
+
+export const WEBHOOK_METHODS = ['GET', 'POST', 'PUT', 'PATCH', 'DELETE', 'HEAD'] as const
+export type WebhookMethod = (typeof WEBHOOK_METHODS)[number]
+
+/** How the webhook caller is authenticated. An open door is `{ type: 'none' }`, never implied. */
+export type WebhookAuth =
+  | { type: 'none' }
+  | { type: 'header'; name: string; secret: string }
+  | { type: 'basic'; username: string; secret: string }
+  | {
+      type: 'hmac'
+      header: string
+      secret: string
+      algorithm: 'sha256' | 'sha512' | 'sha1'
+      encoding: 'hex' | 'base64'
+      /** Stripped before compare, e.g. `sha256=`. */
+      prefix?: string
+    }
+
+/** When and with what the webhook answers its caller. */
+export type WebhookRespond =
+  | {
+      mode: 'immediately'
+      status: number
+      headers?: Record<string, string>
+      body: 'runId' | 'none'
+    }
+  | {
+      mode: 'onFinish'
+      /** Bounded 1s..250s. */
+      timeout: string
+      status: number
+      headers?: Record<string, string>
+      body: 'output' | 'none'
+    }
+  /** A `respond` node answers mid-run. */
+  | { mode: 'node'; timeout: string }
+
+/**
+ * The trigger types are type aliases rather than interfaces on purpose: an
+ * alias gets an implicit index signature, so a stored `Record<string, unknown>`
+ * row can be narrowed to a trigger without going through `unknown` first. An
+ * interface would make that a compile error at every read site.
+ */
+export type WebhookTrigger = {
+  kind: 'webhook'
+  description?: string
+  methods: WebhookMethod[]
+  /** `shipments/:shipmentId`: literal segments and `:name` captures. `''` is the bare workflow URL. */
+  path: string
+  auth: WebhookAuth
+  respond: WebhookRespond
+  /** JSONata over `$request`, giving the run input object. Absent: the body's declared keys. */
+  input?: string
+  /** JSONata over `$request`, giving the subject pk. Required iff the definition has a subject. */
+  subject?: string
+  /** JSONata over `$request`, giving the dedupe key. Absent: no dedupe. */
+  idempotencyKey?: string
+  /** The whole non-multipart body becomes this `file` input. */
+  binaryInput?: string
+  /** `*`, or origins as absolute URLs. */
+  allowedOrigins?: string[]
+  /** IPv4/IPv6 addresses or CIDRs. */
+  ipAllowlist?: string[]
+  ignoreBots?: boolean
+}
+
+export type ManualTrigger = {
+  kind: 'manual'
+  description?: string
+}
+
+export type CronTrigger = {
+  kind: 'cron'
+  description?: string
+  schedule: string
+  input?: Record<string, unknown>
+  /** Run once per object the predicate selects. */
+  subjects?: { where: string; limit?: number }
+}
+
+/** Started by another workflow. */
+export type WorkflowCallTrigger = {
+  kind: 'workflow'
+  description?: string
+}
+
+/** Started by an agent. */
+export type AgentTrigger = {
+  kind: 'agent'
+  description?: string
+}
+
+export type WorkflowTrigger =
+  | ManualTrigger
+  | CronTrigger
+  | WorkflowCallTrigger
+  | AgentTrigger
+  | WebhookTrigger
+
+// ─── Shared node settings ────────────────────────────────────────────────────
+
+export interface RetryPolicy {
+  attempts: number
+  backoff?: 'constant' | 'exponential'
+  /** JSONata predicate: retry only when it holds. */
+  retryIf?: string
+}
+
+export interface WorkflowNodeBase {
+  id: string
+  kind: NodeKind
+  label?: string
+  description?: string
+  resourceId?: string
+  params: Record<string, unknown>
+  retry?: RetryPolicy
+  /** A duration like `30s`, `3m`, `2h`, `1d`. */
+  timeout?: string
+  continueOnError?: boolean
+  cacheTtl?: number
+  mock?: unknown
+  skipIf?: string
+  /**
+   * Authoring state, not a run decision: `enabled: false` parks the step in
+   * the editor. Absent means enabled. A parked step is evaluated by nothing and
+   * leaves no trace at all, unlike `skipIf`, which is evaluated per run and
+   * recorded as a `skipped` node.
+   */
+  enabled?: boolean
+  /**
+   * The step's own predecessors, by node id: it runs once every step it names
+   * has finished. Absent means "after the previous element of my list"; `[]`
+   * means "after nothing", so the step starts with the list. An entry names a
+   * sibling — a step in the same container arm, or the same root list.
+   */
+  after?: string[]
+}
+
+// ─── Node params by kind ─────────────────────────────────────────────────────
+
+export interface BlueprintQueryParams {
+  mode: 'query'
+  /** Read from this saved object set rather than every object of the type. */
+  objectSetId?: string
+  where?: string
+  select?: string[]
+  limit?: number
+}
+export interface BlueprintAggregateParams {
+  mode: 'aggregate'
+  /** Read from this saved object set rather than every object of the type. */
+  objectSetId?: string
+  where?: string
+  groupBy: string[]
+  metrics: Array<{ as: string; fn: 'count' | 'sum' | 'avg' | 'min' | 'max'; property?: string }>
+}
+export interface FunctionParams {
+  version?: number
+  input: DataInput
+}
+export interface LlmParams {
+  prompt: DataInput
+  system?: DataInput
+  files?: DataInput
+  structured?: Record<string, unknown>
+  temperature?: number
+  maxTokens?: number
+}
+export interface ActionParams {
+  input: DataInput
+}
+export interface AgentParams {
+  message: DataInput
+  files?: DataInput
+}
+export interface PluginParams {
+  capability: string
+  input: DataInput
+}
+export interface HttpParams {
+  url: string
+  method: string
+  headers?: Record<string, DataInput>
+  body?: DataInput
+  auth?: { secret: string; header?: string; prefix?: string }
+}
+export interface TransformParams {
+  value: DataInput
+}
+export interface StopParams {
+  result?: DataInput
+  status: 'succeeded' | 'failed'
+}
+export interface BranchParams {
+  cases: Array<{ when: string; nodes: WorkflowNode[] }>
+  else?: WorkflowNode[]
+}
+export interface ForEachParams {
+  over: string
+  parallelism?: number
+  skipFailure?: boolean
+  mode?: 'auto' | 'inline' | 'child'
+  nodes: WorkflowNode[]
+}
+export interface ParallelParams {
+  branches: Array<{ id: string; nodes: WorkflowNode[] }>
+}
+export interface WaitParams {
+  /** Exactly one of `for` or `until`. */
+  for?: string
+  until?: string
+}
+export interface RespondParams {
+  status: number
+  headers?: Record<string, DataInput>
+  body?: DataInput
+}
+
+type NodeOf<K extends NodeKind, P> = Omit<WorkflowNodeBase, 'kind' | 'params'> & { kind: K; params: P }
+
+export type WorkflowNode =
+  | NodeOf<'blueprint', BlueprintQueryParams | BlueprintAggregateParams>
+  | NodeOf<'function', FunctionParams>
+  | NodeOf<'llm', LlmParams>
+  | NodeOf<'action', ActionParams>
+  | NodeOf<'agent', AgentParams>
+  | NodeOf<'plugin', PluginParams>
+  | NodeOf<'http', HttpParams>
+  | NodeOf<'transform', TransformParams>
+  | NodeOf<'stop', StopParams>
+  | NodeOf<'branch', BranchParams>
+  | NodeOf<'forEach', ForEachParams>
+  | NodeOf<'parallel', ParallelParams>
+  | NodeOf<'wait', WaitParams>
+  | NodeOf<'respond', RespondParams>
+
+export interface WorkflowDefinition {
+  apiVersion: typeof WORKFLOW_API_VERSION
+  /** A slug: lowercase letters, digits, dashes. */
+  name: string
+  description?: string
+  subject?: { objectTypeId: string; label?: string }
+  /** The same flat field map Functions declare. */
+  input?: Record<string, Record<string, unknown>>
+  trigger: WorkflowTrigger[]
+  nodes: WorkflowNode[]
+  output?: DataInput
+}