@uipath/maestro-builder-sdk 6.62.0 → 6.64.0

package/dist/api-index.md

@@ -37,7 +37,7 @@ could hand you spans for a version you do not have.
 
 ## `@uipath/maestro-builder-sdk`
 
-243 symbol(s). Import from `@uipath/maestro-builder-sdk`.
+244 symbol(s). Import from `@uipath/maestro-builder-sdk`.
 
 | Symbol | Kind | Declaration | Area | Summary |
 | --- | --- | --- | --- | --- |
@@ -62,14 +62,14 @@ could hand you spans for a version you do not have.
 | `apiWorkflow` | function | `dist/nodes/process/flow/factories.d.ts:53-87` | Actions | Invoke a deployed API workflow — a coded workflow published to Orchestrator, run as a serverless job rather than by a… |
 | `ApiWorkflowInputs` | interface | `dist/nodes/process/flow/spec.d.ts:70-101` | Option shapes | 5 field(s) |
 | `AppRef` | interface | `dist/nodes/hitl/flow/spec.d.ts:146-225` | 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:1364-1387` | Builders | The sub-builder an ARM callback receives — a `StepList` that can also name itself with `.label(...)`. |
+| `ArmBuilder` | class | `dist/flow-sdk.d.ts:1385-1408` | Builders | The sub-builder an ARM callback receives — a `StepList` that can also name itself with `.label(...)`. |
 | `AskedField` | interface | `dist/core/actions.d.ts:221-240` | Supporting types | A value the reviewer FILLS IN: read downstream with `out('<step>', '<id>')`. |
-| `at` | function | `dist/flow-sdk.d.ts:693-721` | Flow construction | A node's layout at a canvas position — the short form of a NodeLayout for the `nodes` map of FlowBuilder.layout. |
+| `at` | function | `dist/flow-sdk.d.ts:714-742` | Flow construction | A node's layout at a canvas position — the short form of a NodeLayout for the `nodes` map of FlowBuilder.layout. |
 | `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:821-833` | Supporting types | One additional flow root, built by `.entryPoint()`. |
-| `BuiltFlow` | interface | `dist/flow-sdk.d.ts:834-881` | Supporting types | 17 field(s) |
+| `BuiltEntryPoint` | interface | `dist/flow-sdk.d.ts:842-854` | Supporting types | One additional flow root, built by `.entryPoint()`. |
+| `BuiltFlow` | interface | `dist/flow-sdk.d.ts:855-902` | Supporting types | 17 field(s) |
 | `BuiltinToolName` | type | `dist/core/actions.d.ts:394-395` | Supporting types | The three platform-shipped built-in tools (fixed registry types). |
 | `BuiltinToolRef` | interface | `dist/core/actions.d.ts:563-583` | Supporting types | A platform built-in tool. |
 | `BuiltInValidatorGuardrail` | interface | `dist/core/actions.d.ts:351-392` | Supporting types | A platform-shipped validator, configured by parameters. |
@@ -116,14 +116,14 @@ could hand you spans for a version you do not have.
 | `DELAY_PRESETS` | const | `dist/nodes/delay/flow/spec.d.ts:6-13` | Actions | The twelve durations the designer's dropdown offers. |
 | `DelayInputs` | type | `dist/nodes/delay/flow/spec.d.ts:14-35` | Option shapes |  |
 | `descriptor` | function | `dist/core/connectors.d.ts:98-110` | Generated descriptors | Brand a descriptor literal with its input/output types (zero runtime cost). |
-| `dim` | function | `dist/flow-sdk.d.ts:722-744` | Flow construction | A node's size on the canvas, in pixels — the third argument of at. |
+| `dim` | function | `dist/flow-sdk.d.ts:743-765` | Flow construction | A node's size on the canvas, in pixels — the third argument of at. |
 | `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:10-20` | Option shapes | What `documentClassify()` takes: the document, and how to split and classify it. |
 | `DocValidationInputs` | interface | `dist/nodes/hitl/flow/spec.d.ts:76-99` | Option shapes | The Document Validation task's subject — `variant: 'document-validation'` only. |
-| `DoWhileOptions` | interface | `dist/flow-sdk.d.ts:547-556` | Option shapes | Do-while options. |
+| `DoWhileOptions` | interface | `dist/flow-sdk.d.ts:568-577` | 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:21-56` | Option shapes | What `dynamicExtract()` takes: the document and the fields to extract from it. |
-| `EdgeRoute` | interface | `dist/flow-sdk.d.ts:745-759` | Supporting types | One edge's route: user-dragged bends and/or the auto-router's waypoints. |
+| `EdgeRoute` | interface | `dist/flow-sdk.d.ts:766-780` | Supporting types | One edge's route: user-dragged bends and/or the auto-router's waypoints. |
 | `endCall` | function | `dist/nodes/agent/flow/factories.d.ts:26-33` | Actions | Hang up (`uipath.conversational.voice.end-call`). |
 | `EndCallInputs` | interface | `dist/nodes/agent/flow/spec.d.ts:96-104` | Option shapes | What `endCall()` takes: the call to hang up. |
 | `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` —… |
@@ -137,12 +137,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:1769-1784` | Flow construction | Start building a flow with the given id. |
+| `flow` | function | `dist/flow-sdk.d.ts:1790-1805` | 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:55-56` | Supporting types | What `.step()` accepts here: the shared actions plus this SDK's subflow. |
 | `FlowActionSpecs` | interface | `dist/core/actions.d.ts:813-846` | 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:1388-1768` | Builders | 15 member(s) |
-| `FlowLayout` | interface | `dist/flow-sdk.d.ts:807-820` | 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:1409-1789` | Builders | 15 member(s) |
+| `FlowLayout` | interface | `dist/flow-sdk.d.ts:828-841` | 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(…)`. |
@@ -195,19 +195,19 @@ could hand you spans for a version you do not have.
 | `lookupSpecOf` | function | `dist/core/lookups.d.ts:234-241` | 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:522-546` | Option shapes | Loop-specific options. |
+| `LoopOptions` | interface | `dist/flow-sdk.d.ts:543-567` | Option shapes | Loop-specific options. |
 | `manual` | function | `dist/flow-sdk.d.ts:183-192` | Flow construction | The manual trigger, explicitly. |
 | `McpToolRef` | interface | `dist/core/actions.d.ts:442-470` | 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:678-692` | Supporting types | One node's designer layout: canvas position, and optionally size and collapsed state. |
+| `NodeLayout` | interface | `dist/flow-sdk.d.ts:699-713` | Supporting types | One node's designer layout: canvas position, and optionally size and collapsed state. |
 | `NodeOptions` | interface | `dist/flow-sdk.d.ts:393-446` | 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:193-231` | 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:232-239` | 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:100-119` | 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. |
-| `ParallelOptions` | interface | `dist/flow-sdk.d.ts:447-470` | Option shapes | The options of `.parallel()`: the join's NodeOptions, plus the fork node when the flow has one. |
+| `ParallelOptions` | interface | `dist/flow-sdk.d.ts:468-491` | Option shapes | The options of `.parallel()`: the join's NodeOptions, plus the fork node when the flow has one. |
 | `PlatformActionSchema` | interface | `dist/nodes/hitl/flow/spec.d.ts:276-288` | Supporting types | The platform's action schema (Apps API, a solution's `spec.actionSchema`). |
 | `PlatformActionSchemaArg` | interface | `dist/nodes/hitl/flow/spec.d.ts:263-275` | Supporting types | One argument of the platform's action schema. |
 | `PortArm` | interface | `dist/flow-sdk.d.ts:380-392` | Supporting types | One arm of a built `.stepSwitch` — the same shape as SwitchArm, but `value` names an exit the ACTION declares (a… |
@@ -227,7 +227,7 @@ could hand you spans for a version you do not have.
 | `resolvedValue` | function | `dist/core/lookups.d.ts:177-184` | Generated descriptors | The recorded id for a token, or `undefined`. |
 | `resolveEventWhere` | function | `dist/core/lookups.d.ts:242-259` | 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:268-285` | Supporting types | A JSON-schema-ish type for one field of a step's declared `returns`. |
-| `ReturnOptions` | interface | `dist/flow-sdk.d.ts:480-521` | Option shapes | `.return(...)`-specific options. |
+| `ReturnOptions` | interface | `dist/flow-sdk.d.ts:501-542` | Option shapes | `.return(...)`-specific options. |
 | `rpaWorkflow` | function | `dist/nodes/process/flow/factories.d.ts:8-52` | Actions | Invoke a deployed RPA (robotic process automation) workflow — a classic UI-automation process, published to… |
 | `RpaWorkflowInputs` | interface | `dist/nodes/process/flow/spec.d.ts:11-69` | Option shapes | 7 field(s) |
 | `SCHEDULE_PRESETS` | const | `dist/flow-sdk.d.ts:130-137` | Flow construction | The eight intervals the designer offers in its Frequency dropdown. |
@@ -246,12 +246,13 @@ 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:205-220` | Supporting types | A value the reviewer READS: shown on the form, filled in from the flow. |
-| `Step` | type | `dist/flow-sdk.d.ts:557-677` | Supporting types |  |
-| `StepList` | class | `dist/flow-sdk.d.ts:882-1363` | Builders | Collects a sequence of steps. |
-| `STICKY_NOTE_COLORS` | const | `dist/flow-sdk.d.ts:760-765` | Flow construction | The designer's sticky-note palette. |
-| `StickyNote` | interface | `dist/flow-sdk.d.ts:772-806` | Supporting types | A canvas sticky note — free text pinned to the diagram, for the humans reading it. |
-| `StickyNoteColor` | type | `dist/flow-sdk.d.ts:766-771` | Supporting types | A sticky note's swatch. |
-| `subflow` | function | `dist/flow-sdk.d.ts:1785-1824` | Flow construction | Run another flow as one step, and read back what it returns. |
+| `Step` | type | `dist/flow-sdk.d.ts:578-698` | Supporting types |  |
+| `StepList` | class | `dist/flow-sdk.d.ts:903-1384` | Builders | Collects a sequence of steps. |
+| `StepOptions` | interface | `dist/flow-sdk.d.ts:447-467` | Option shapes | The options of `.step()`: the NodeOptions, plus `draft` for a node the canvas saved unfinished. |
+| `STICKY_NOTE_COLORS` | const | `dist/flow-sdk.d.ts:781-786` | Flow construction | The designer's sticky-note palette. |
+| `StickyNote` | interface | `dist/flow-sdk.d.ts:793-827` | Supporting types | A canvas sticky note — free text pinned to the diagram, for the humans reading it. |
+| `StickyNoteColor` | type | `dist/flow-sdk.d.ts:787-792` | Supporting types | A sticky note's swatch. |
+| `subflow` | function | `dist/flow-sdk.d.ts:1806-1845` | Flow construction | Run another flow as one step, and read back what it returns. |
 | `SubflowSpec` | interface | `dist/flow-sdk.d.ts:47-54` | 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) |