@uipath/maestro-builder-sdk 6.26.0 → 6.27.1

package/dist/api-index.md

@@ -37,7 +37,7 @@ could hand you spans for a version you do not have.
 
 ## `@uipath/maestro-builder-sdk`
 
-219 symbol(s). Import from `@uipath/maestro-builder-sdk`.
+220 symbol(s). Import from `@uipath/maestro-builder-sdk`.
 
 | Symbol | Kind | Declaration | Area | Summary |
 | --- | --- | --- | --- | --- |
@@ -57,13 +57,13 @@ could hand you spans for a version you do not have.
 | `apiWorkflow` | function | `dist/core/actions.d.ts:1658-1692` | Actions | Invoke a deployed API workflow — a coded workflow published to Orchestrator, run as a serverless job rather than by a… |
 | `ApiWorkflowInputs` | interface | `dist/core/actions.d.ts:411-442` | Option shapes | 5 field(s) |
 | `AppRef` | interface | `dist/nodes/hitl/flow/spec.d.ts:140-185` | Supporting types | A deployed Action App that supplies a human task's form — the `'action-app'` variant's subject. |
-| `ArmBuilder` | class | `dist/flow-sdk.d.ts:1193-1216` | Builders | The sub-builder an ARM callback receives — a `StepList` that can also name itself with `.label(...)`. |
+| `ArmBuilder` | class | `dist/flow-sdk.d.ts:1224-1247` | Builders | The sub-builder an ARM callback receives — a `StepList` that can also name itself with `.label(...)`. |
 | `AskedField` | interface | `dist/core/actions.d.ts:79-89` | Supporting types | A value the reviewer FILLS IN: read downstream with `out('<step>', '<id>')`. |
 | `batchTransform` | function | `dist/nodes/ai-patterns/flow/factories.d.ts:49-83` | Actions | Add AI-generated columns to a CSV — the platform's **Batch transform** node, `uipath.pattern.batch-transform` (service… |
 | `BatchTransformInputs` | interface | `dist/nodes/ai-patterns/flow/spec.d.ts:48-63` | Option shapes | 4 field(s) |
 | `BindingContribution` | interface | `dist/core/node-classes.d.ts:80-101` | Supporting types | A resource binding a contribution hoists to the flow's top-level `bindings` array — the shape the `.flow` format… |
-| `BuiltEntryPoint` | interface | `dist/flow-sdk.d.ts:695-707` | Supporting types | One additional flow root, built by `.entryPoint()`. |
-| `BuiltFlow` | interface | `dist/flow-sdk.d.ts:708-749` | Supporting types | 16 field(s) |
+| `BuiltEntryPoint` | interface | `dist/flow-sdk.d.ts:719-731` | Supporting types | One additional flow root, built by `.entryPoint()`. |
+| `BuiltFlow` | interface | `dist/flow-sdk.d.ts:732-773` | Supporting types | 16 field(s) |
 | `BuiltinToolName` | type | `dist/core/actions.d.ts:1066-1067` | Supporting types | The three platform-shipped built-in tools (fixed registry types). |
 | `BuiltinToolRef` | interface | `dist/core/actions.d.ts:1199-1219` | Supporting types | A platform built-in tool. |
 | `BuiltInValidatorGuardrail` | interface | `dist/core/actions.d.ts:762-803` | Supporting types | A platform-shipped validator, configured by parameters. |
@@ -111,10 +111,10 @@ could hand you spans for a version you do not have.
 | `documentClassify` | function | `dist/nodes/document/flow/factories.d.ts:8-16` | Actions | Classify a document into a document type (`uipath.document.classify`). |
 | `DocumentClassifyInputs` | interface | `dist/nodes/document/flow/spec.d.ts:9-18` | Option shapes | 4 field(s) |
 | `DocValidationInputs` | interface | `dist/nodes/hitl/flow/spec.d.ts:70-93` | Option shapes | The Document Validation task's subject — `variant: 'document-validation'` only. |
-| `DoWhileOptions` | interface | `dist/flow-sdk.d.ts:474-483` | Option shapes | Do-while options. |
+| `DoWhileOptions` | interface | `dist/flow-sdk.d.ts:498-507` | Option shapes | Do-while options. |
 | `dynamicExtract` | function | `dist/nodes/document/flow/factories.d.ts:17-27` | Actions | Extract fields from a document with an INLINE schema — Dynamic Extract (`uipath.ixp.extract-document-builder`), the… |
 | `DynamicExtractInputs` | interface | `dist/nodes/document/flow/spec.d.ts:19-53` | Option shapes | 5 field(s) |
-| `EdgeRoute` | interface | `dist/flow-sdk.d.ts:619-633` | Supporting types | One edge's route: user-dragged bends and/or the auto-router's waypoints. |
+| `EdgeRoute` | interface | `dist/flow-sdk.d.ts:643-657` | Supporting types | One edge's route: user-dragged bends and/or the auto-router's waypoints. |
 | `endCall` | function | `dist/core/actions.d.ts:1735-1742` | Actions | Hang up (`uipath.conversational.voice.end-call`). |
 | `EndCallInputs` | interface | `dist/core/actions.d.ts:189-196` | Option shapes | 1 field(s) |
 | `entryInput` | function | `dist/core/expr.d.ts:62-72` | Expressions and types | Reference an ENTRY POINT's scoped input: `entryInput('nightly', 'batchDate')` reads `$vars.nightly.output.batchDate` —… |
@@ -128,12 +128,12 @@ could hand you spans for a version you do not have.
 | `FilterCondition` | type | `dist/nodes/transform/flow/spec.d.ts:10-11` | Supporting types | Comparison a filter rule applies to a field. |
 | `FilterMatch` | type | `dist/nodes/transform/flow/spec.d.ts:8-9` | Supporting types | How a filter combines its rules: every rule must match, or any one. |
 | `FilterRule` | interface | `dist/nodes/transform/flow/spec.d.ts:12-24` | Supporting types | 3 field(s) |
-| `flow` | function | `dist/flow-sdk.d.ts:1541-1556` | Flow construction | Start building a flow with the given id. |
+| `flow` | function | `dist/flow-sdk.d.ts:1572-1587` | Flow construction | Start building a flow with the given id. |
 | `FlowAction` | class | `dist/core/node-classes.d.ts:162-168` | Supporting types | A node placed as a step — pass an instance to `.step(name, …)`. |
 | `FlowActionSpec` | type | `dist/flow-sdk.d.ts:53-54` | Supporting types | What `.step()` accepts here: the shared actions plus this SDK's subflow. |
 | `FlowActionSpecs` | interface | `dist/core/actions.d.ts:1443-1520` | Supporting types | Every action kind, keyed by kind, to the body of its spec — the arm's fields other than `kind`. |
-| `FlowBuilder` | class | `dist/flow-sdk.d.ts:1217-1540` | Builders | 14 member(s) |
-| `FlowLayout` | interface | `dist/flow-sdk.d.ts:681-694` | Supporting types | Designer layout for a flow, keyed by AUTHOR-level ids: node entries by step name (plus the trigger id and `end`), edge… |
+| `FlowBuilder` | class | `dist/flow-sdk.d.ts:1248-1571` | Builders | 14 member(s) |
+| `FlowLayout` | interface | `dist/flow-sdk.d.ts:705-718` | Supporting types | Designer layout for a flow, keyed by AUTHOR-level ids: node entries by step name (plus the trigger id and `end`), edge… |
 | `FlowNode` | class | `dist/core/node-classes.d.ts:126-161` | Supporting types | The abstract root of every definition-backed node the builder can place. |
 | `FlowResource` | class | `dist/core/node-classes.d.ts:176-183` | Supporting types | A node attached to another semantic node — an inline agent's tool, context, memory, or escalation. |
 | `FlowTrigger` | class | `dist/core/node-classes.d.ts:169-175` | Supporting types | A node that starts the flow — pass an instance to `.trigger(…)`. |
@@ -181,19 +181,19 @@ could hand you spans for a version you do not have.
 | `lookupSpecOf` | function | `dist/core/lookups.d.ts:199-206` | Generated descriptors | The LookupSpec for one field, or `undefined` when it earns no helper. |
 | `LookupStrategy` | type | `dist/core/lookups.d.ts:1-10` | Generated descriptors | How `prepare` should retrieve the collection, chosen from the metadata. |
 | `LookupToken` | interface | `dist/core/lookups.d.ts:37-52` | Generated descriptors | An unresolved lookup: what `.byEmail(…)` returns. |
-| `LoopOptions` | interface | `dist/flow-sdk.d.ts:453-473` | Option shapes | Loop-specific options. |
+| `LoopOptions` | interface | `dist/flow-sdk.d.ts:477-497` | Option shapes | Loop-specific options. |
 | `manual` | function | `dist/flow-sdk.d.ts:181-190` | Flow construction | The manual trigger, explicitly. |
 | `McpToolRef` | interface | `dist/core/actions.d.ts:1078-1106` | Supporting types | An MCP server the agent may call tools on. |
 | `mock` | function | `dist/nodes/mock/flow/factories.d.ts:6-45` | Actions | Declare a PLACEHOLDER step — "a real node goes here later". |
 | `NodeContribution` | interface | `dist/core/node-classes.d.ts:102-125` | Supporting types | One validated construct, returned by FlowNode.contribute. |
-| `NodeLayout` | interface | `dist/flow-sdk.d.ts:604-618` | Supporting types | One node's designer layout: canvas position, and optionally size and collapsed state. |
-| `NodeOptions` | interface | `dist/flow-sdk.d.ts:367-420` | Option shapes | Options shared by every builder method that creates a definition-backed node: `version` selects the exact node… |
+| `NodeLayout` | interface | `dist/flow-sdk.d.ts:628-642` | Supporting types | One node's designer layout: canvas position, and optionally size and collapsed state. |
+| `NodeOptions` | interface | `dist/flow-sdk.d.ts:391-444` | Option shapes | Options shared by every builder method that creates a definition-backed node: `version` selects the exact node… |
 | `onEvent` | function | `dist/flow-sdk.d.ts:191-229` | Flow construction | Start the flow when a connector event fires — e.g. an email arriving in a mailbox folder. |
 | `onEvent` | function | `dist/flow-sdk.d.ts:230-237` | Flow construction | Stringly form, for an event with no prepared module. |
 | `out` | function | `dist/core/expr.d.ts:73-94` | Expressions and types | Reference an upstream step's output → `$vars.<step>.output[.<path>]`. |
 | `Outcome` | type | `dist/nodes/hitl/flow/spec.d.ts:94-113` | Supporting types | One completion button. |
 | `OutputColumn` | interface | `dist/nodes/ai-patterns/flow/spec.d.ts:41-47` | Supporting types | One column Batch Transform appends to the CSV. |
-| `PortArm` | interface | `dist/flow-sdk.d.ts:354-366` | Supporting types | One arm of a built `.stepSwitch` — the same shape as SwitchArm, but `value` names an exit the ACTION declares (a… |
+| `PortArm` | interface | `dist/flow-sdk.d.ts:378-390` | Supporting types | One arm of a built `.stepSwitch` — the same shape as SwitchArm, but `value` names an exit the ACTION declares (a… |
 | `ProcessLocation` | type | `dist/core/actions.d.ts:346-351` | Supporting types | Where a process resource lives: deployed to an Orchestrator folder (`'published'`, the default) or a sibling project of… |
 | `ProcessToolKind` | type | `dist/core/actions.d.ts:1258-1271` | Supporting types | The tool kinds that wrap a DEPLOYED tenant resource. |
 | `ProcessToolRef` | interface | `dist/core/actions.d.ts:1272-1301` | Supporting types | A deployed tenant resource the agent may invoke. |
@@ -209,7 +209,7 @@ could hand you spans for a version you do not have.
 | `resolvedValue` | function | `dist/core/lookups.d.ts:172-179` | Generated descriptors | The recorded id for a token, or `undefined`. |
 | `resolveEventWhere` | function | `dist/core/lookups.d.ts:207-224` | Generated descriptors | An event subscription's `where` with every lookup token swapped for the id `registry prepare --resolve` recorded, or a… |
 | `ReturnFieldType` | type | `dist/core/actions.d.ts:679-696` | Supporting types | A JSON-schema-ish type for one field of a step's declared `returns`. |
-| `ReturnOptions` | interface | `dist/flow-sdk.d.ts:421-452` | Option shapes | `.return(...)`-specific options. |
+| `ReturnOptions` | interface | `dist/flow-sdk.d.ts:445-476` | Option shapes | `.return(...)`-specific options. |
 | `rpaWorkflow` | function | `dist/core/actions.d.ts:1613-1657` | Actions | Invoke a deployed RPA (robotic process automation) workflow — a classic UI-automation process, published to… |
 | `RpaWorkflowInputs` | interface | `dist/core/actions.d.ts:352-410` | Option shapes | 7 field(s) |
 | `SCHEDULE_PRESETS` | const | `dist/flow-sdk.d.ts:128-135` | Flow construction | The eight intervals the designer offers in its Frequency dropdown. |
@@ -224,16 +224,17 @@ could hand you spans for a version you do not have.
 | `sendMessage` | function | `dist/nodes/conversation/flow/factories.d.ts:8-26` | Actions | Post an assistant message into a live conversation (`uipath.conversational.send-message`). |
 | `SendMessageInputs` | interface | `dist/nodes/conversation/flow/spec.d.ts:8-27` | Option shapes | 4 field(s) |
 | `ShownField` | interface | `dist/core/actions.d.ts:63-78` | Supporting types | A value the reviewer READS: shown on the form, filled in from the flow. |
-| `Step` | type | `dist/flow-sdk.d.ts:484-603` | Supporting types |  |
-| `StepList` | class | `dist/flow-sdk.d.ts:750-1192` | Builders | Collects a sequence of steps. |
-| `STICKY_NOTE_COLORS` | const | `dist/flow-sdk.d.ts:634-639` | Flow construction | The designer's sticky-note palette. |
-| `StickyNote` | interface | `dist/flow-sdk.d.ts:646-680` | Supporting types | A canvas sticky note — free text pinned to the diagram, for the humans reading it. |
-| `StickyNoteColor` | type | `dist/flow-sdk.d.ts:640-645` | Supporting types | A sticky note's swatch. |
-| `subflow` | function | `dist/flow-sdk.d.ts:1557-1596` | Flow construction | Run another flow as one step, and read back what it returns. |
+| `Step` | type | `dist/flow-sdk.d.ts:508-627` | Supporting types |  |
+| `StepList` | class | `dist/flow-sdk.d.ts:774-1223` | Builders | Collects a sequence of steps. |
+| `STICKY_NOTE_COLORS` | const | `dist/flow-sdk.d.ts:658-663` | Flow construction | The designer's sticky-note palette. |
+| `StickyNote` | interface | `dist/flow-sdk.d.ts:670-704` | Supporting types | A canvas sticky note — free text pinned to the diagram, for the humans reading it. |
+| `StickyNoteColor` | type | `dist/flow-sdk.d.ts:664-669` | Supporting types | A sticky note's swatch. |
+| `subflow` | function | `dist/flow-sdk.d.ts:1588-1627` | Flow construction | Run another flow as one step, and read back what it returns. |
 | `SubflowSpec` | interface | `dist/flow-sdk.d.ts:45-52` | Supporting types | A step that runs a child flow. |
 | `summarize` | function | `dist/nodes/ai-patterns/flow/factories.d.ts:8-48` | Actions | Summarize a document with citations — the platform's **Summarize** node. |
 | `SummarizeInputs` | interface | `dist/nodes/ai-patterns/flow/spec.d.ts:8-40` | Option shapes | 3 field(s) |
-| `SwitchArm` | interface | `dist/flow-sdk.d.ts:341-353` | Supporting types | One arm of a built `.switch` (the serializer's view: body already collected). |
+| `SwitchArm` | interface | `dist/flow-sdk.d.ts:358-377` | Supporting types | One arm of a built `.switch` (the serializer's view: body already collected). |
+| `SwitchCase` | type | `dist/flow-sdk.d.ts:341-357` | Supporting types | One case of `.switch(name, on, cases)`: either `{ value }`, taken when `on === value`, or `{ when }`, taken when its own… |
 | `tmpl` | function | `dist/core/expr.d.ts:283-293` | Expressions and types | Build a JS *string template* (for URLs, messages, etc.). |
 | `ToolRef` | type | `dist/core/actions.d.ts:1068-1077` | Supporting types | One tool on an inline agent — a discriminated union over the kinds the tenant's registry actually serves… |
 | `transform` | function | `dist/nodes/transform/flow/factories.d.ts:7-52` | Actions | Declare a Transform action — a chain of declarative operations over a collection. |