@uipath/maestro-builder-sdk 6.15.6 → 6.16.0

package/dist/api-index.md

@@ -57,17 +57,17 @@ could hand you spans for a version you do not have.
 | `apiWorkflow` | function | `dist/core/actions.d.ts:2811-2845` | 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:1013-1044` | Option shapes | 5 field(s) |
 | `AppRef` | interface | `dist/core/actions.d.ts:506-551` | 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:1097-1120` | Builders | The sub-builder an ARM callback receives — a `StepList` that can also name itself with `.label(...)`. |
+| `ArmBuilder` | class | `dist/flow-sdk.d.ts:1132-1155` | Builders | The sub-builder an ARM callback receives — a `StepList` that can also name itself with `.label(...)`. |
 | `AskedField` | interface | `dist/core/actions.d.ts:354-364` | Supporting types | A value the reviewer FILLS IN: read downstream with `out('<step>', '<id>')`. |
 | `batchTransform` | function | `dist/core/actions.d.ts:2614-2648` | Actions | Add AI-generated columns to a CSV — the platform's **Batch transform** node, `uipath.pattern.batch-transform` (service… |
 | `BatchTransformInputs` | interface | `dist/core/actions.d.ts:837-852` | Option shapes | 4 field(s) |
 | `BindingContribution` | interface | `dist/core/node-classes.d.ts:76-97` | 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:625-637` | Supporting types | One additional flow root, built by `.entryPoint()`. |
-| `BuiltFlow` | interface | `dist/flow-sdk.d.ts:638-673` | Supporting types | 15 field(s) |
+| `BuiltEntryPoint` | interface | `dist/flow-sdk.d.ts:660-672` | Supporting types | One additional flow root, built by `.entryPoint()`. |
+| `BuiltFlow` | interface | `dist/flow-sdk.d.ts:673-708` | Supporting types | 15 field(s) |
 | `BuiltinToolName` | type | `dist/core/actions.d.ts:1641-1642` | Supporting types | The three platform-shipped built-in tools (fixed registry types). |
 | `BuiltinToolRef` | interface | `dist/core/actions.d.ts:1774-1794` | Supporting types | A platform built-in tool. |
 | `BuiltInValidatorGuardrail` | interface | `dist/core/actions.d.ts:1342-1383` | Supporting types | A platform-shipped validator, configured by parameters. |
-| `CaseValue` | type | `dist/flow-sdk.d.ts:292-293` | Supporting types | A value a `.switch` case compares the discriminant against. |
+| `CaseValue` | type | `dist/flow-sdk.d.ts:327-328` | Supporting types | A value a `.switch` case compares the discriminant against. |
 | `ChildFlow` | type | `dist/flow-sdk.d.ts:43-46` | Supporting types | Anything `subflow()` accepts as the child: a builder, or an already-built flow. |
 | `ClientSideToolRef` | interface | `dist/core/actions.d.ts:1703-1718` | Supporting types | A CLIENT-side tool: the agent asks the CALLING application to run it and hand the answer back… |
 | `connector` | function | `dist/core/actions.d.ts:3306-3329` | Actions | Declare an Integration Service connector action — the typed form, where a generated descriptor supplies the nodeType and… |
@@ -86,7 +86,7 @@ could hand you spans for a version you do not have.
 | `ConversationalAgentSettings` | interface | `dist/core/actions.d.ts:661-684` | Supporting types | How a conversational agent gets its turn — the node's own `conversationalAgentSettings` sub-object. |
 | `conversationContext` | function | `dist/core/actions.d.ts:2907-2921` | Actions | READ a conversation's transcript so far without waiting (`uipath.conversational.get-conversation-context`) — the shape a… |
 | `ConversationContextInputs` | interface | `dist/core/actions.d.ts:653-660` | Option shapes | 2 field(s) |
-| `conversationTrigger` | function | `dist/flow-sdk.d.ts:240-266` | Flow construction | Start the flow when a new CONVERSATION is created (`core.trigger.conversation`) — the entry point for a chat-driven… |
+| `conversationTrigger` | function | `dist/flow-sdk.d.ts:275-301` | Flow construction | Start the flow when a new CONVERSATION is created (`core.trigger.conversation`) — the entry point for a chat-driven… |
 | `createOutgoingCall` | function | `dist/core/actions.d.ts:2922-2938` | Actions | Place an outgoing phone call (`uipath.conversational.voice.create-outgoing-call`) and get back the `callContext` every… |
 | `CreateOutgoingCallInputs` | interface | `dist/core/actions.d.ts:723-731` | Option shapes | 2 field(s) |
 | `CustomGuardrail` | interface | `dist/core/actions.d.ts:1329-1341` | Supporting types | A rule-based guardrail you author in place. |
@@ -111,10 +111,10 @@ could hand you spans for a version you do not have.
 | `documentClassify` | function | `dist/core/actions.d.ts:3149-3157` | Actions | Classify a document into a document type (`uipath.document.classify`). |
 | `DocumentClassifyInputs` | interface | `dist/core/actions.d.ts:2292-2301` | Option shapes | 4 field(s) |
 | `DocValidationInputs` | interface | `dist/core/actions.d.ts:444-467` | Option shapes | The Document Validation task's subject — `variant: 'document-validation'` only. |
-| `DoWhileOptions` | interface | `dist/flow-sdk.d.ts:412-421` | Option shapes | Do-while options. |
+| `DoWhileOptions` | interface | `dist/flow-sdk.d.ts:447-456` | Option shapes | Do-while options. |
 | `dynamicExtract` | function | `dist/core/actions.d.ts:3158-3168` | Actions | Extract fields from a document with an INLINE schema — Dynamic Extract (`uipath.ixp.extract-document-builder`), the… |
 | `DynamicExtractInputs` | interface | `dist/core/actions.d.ts:2302-2336` | Option shapes | 5 field(s) |
-| `EdgeRoute` | interface | `dist/flow-sdk.d.ts:549-563` | Supporting types | One edge's route: user-dragged bends and/or the auto-router's waypoints. |
+| `EdgeRoute` | interface | `dist/flow-sdk.d.ts:584-598` | Supporting types | One edge's route: user-dragged bends and/or the auto-router's waypoints. |
 | `endCall` | function | `dist/core/actions.d.ts:2939-2946` | Actions | Hang up (`uipath.conversational.voice.end-call`). |
 | `EndCallInputs` | interface | `dist/core/actions.d.ts:732-739` | 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,17 +128,17 @@ could hand you spans for a version you do not have.
 | `FilterCondition` | type | `dist/core/actions.d.ts:233-234` | Supporting types | Comparison a filter rule applies to a field. |
 | `FilterMatch` | type | `dist/core/actions.d.ts:231-232` | Supporting types | How a filter combines its rules: every rule must match, or any one. |
 | `FilterRule` | interface | `dist/core/actions.d.ts:235-247` | Supporting types | 3 field(s) |
-| `flow` | function | `dist/flow-sdk.d.ts:1371-1386` | Flow construction | Start building a flow with the given id. |
+| `flow` | function | `dist/flow-sdk.d.ts:1423-1438` | Flow construction | Start building a flow with the given id. |
 | `FlowAction` | class | `dist/core/node-classes.d.ts:158-164` | Supporting types | A node placed as a step — pass an instance to `.step(name, …)`. |
 | `FlowActionSpec` | type | `dist/flow-sdk.d.ts:41-42` | Supporting types | What `.step()` accepts here: the shared actions plus this SDK's subflow. |
-| `FlowBuilder` | class | `dist/flow-sdk.d.ts:1121-1370` | Builders | 13 member(s) |
-| `FlowLayout` | interface | `dist/flow-sdk.d.ts:611-624` | 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:1156-1422` | Builders | 13 member(s) |
+| `FlowLayout` | interface | `dist/flow-sdk.d.ts:646-659` | 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:122-157` | Supporting types | The abstract root of every definition-backed node the builder can place. |
 | `FlowResource` | class | `dist/core/node-classes.d.ts:172-179` | 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:165-171` | Supporting types | A node that starts the flow — pass an instance to `.trigger(…)`. |
 | `FormField` | type | `dist/core/actions.d.ts:383` | Supporting types |  |
 | `FormFieldType` | type | `dist/core/actions.d.ts:332-337` | Supporting types | A form field's type. |
-| `formTrigger` | function | `dist/flow-sdk.d.ts:211-239` | Flow construction | Start the flow from a FORM a person fills in (`core.trigger.form`) — the platform renders one field per flow input and… |
+| `formTrigger` | function | `dist/flow-sdk.d.ts:246-274` | Flow construction | Start the flow from a FORM a person fills in (`core.trigger.form`) — the platform renders one field per flow input and… |
 | `GuardrailAction` | type | `dist/core/actions.d.ts:1318-1328` | Supporting types | What happens when a guardrail trips. |
 | `GuardrailFieldReference` | interface | `dist/core/actions.d.ts:1285-1290` | Supporting types | A field the rule or filter action points at. |
 | `GuardrailFieldSelector` | type | `dist/core/actions.d.ts:1291-1297` | Supporting types | All fields, or a named few. |
@@ -180,19 +180,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:391-411` | Option shapes | Loop-specific options. |
-| `manual` | function | `dist/flow-sdk.d.ts:134-143` | Flow construction | The manual trigger, explicitly. |
+| `LoopOptions` | interface | `dist/flow-sdk.d.ts:426-446` | Option shapes | Loop-specific options. |
+| `manual` | function | `dist/flow-sdk.d.ts:169-178` | Flow construction | The manual trigger, explicitly. |
 | `McpToolRef` | interface | `dist/core/actions.d.ts:1653-1681` | Supporting types | An MCP server the agent may call tools on. |
 | `mock` | function | `dist/core/actions.d.ts:2726-2765` | Actions | Declare a PLACEHOLDER step — "a real node goes here later". |
 | `NodeContribution` | interface | `dist/core/node-classes.d.ts:98-121` | Supporting types | One validated construct, returned by FlowNode.contribute. |
-| `NodeLayout` | interface | `dist/flow-sdk.d.ts:534-548` | Supporting types | One node's designer layout: canvas position, and optionally size and collapsed state. |
-| `NodeOptions` | interface | `dist/flow-sdk.d.ts:313-358` | 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:144-182` | 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:183-190` | Flow construction | Stringly form, for an event with no prepared module. |
+| `NodeLayout` | interface | `dist/flow-sdk.d.ts:569-583` | Supporting types | One node's designer layout: canvas position, and optionally size and collapsed state. |
+| `NodeOptions` | interface | `dist/flow-sdk.d.ts:348-393` | 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:179-217` | 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:218-225` | 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/core/actions.d.ts:468-479` | Supporting types | One completion button. |
 | `OutputColumn` | interface | `dist/core/actions.d.ts:830-836` | Supporting types | One column Batch Transform appends to the CSV. |
-| `PortArm` | interface | `dist/flow-sdk.d.ts:300-312` | 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:335-347` | Supporting types | One arm of a built `.stepSwitch` — the same shape as SwitchArm, but `value` names an exit the ACTION declares (a… |
 | `ProcessToolKind` | type | `dist/core/actions.d.ts:1833-1846` | Supporting types | The tool kinds that wrap a DEPLOYED tenant resource. |
 | `ProcessToolRef` | interface | `dist/core/actions.d.ts:1847-1876` | Supporting types | A deployed tenant resource the agent may invoke. |
 | `publishedFunction` | function | `dist/core/actions.d.ts:2846-2870` | Actions | Invoke a published Orchestrator **Function** — a deployed unit of code run as one step (`uipath.core.function.<key>`,… |
@@ -207,14 +207,14 @@ could hand you spans for a version you do not have.
 | `RemoteA2aToolRef` | interface | `dist/core/actions.d.ts:1682-1702` | Supporting types | A remote A2A (agent-to-agent) endpoint the agent may delegate to. |
 | `resolvedValue` | function | `dist/core/lookups.d.ts:172-179` | Generated descriptors | The recorded id for a token, or `undefined`. |
 | `ReturnFieldType` | type | `dist/core/actions.d.ts:1259-1276` | Supporting types | A JSON-schema-ish type for one field of a step's declared `returns`. |
-| `ReturnOptions` | interface | `dist/flow-sdk.d.ts:359-390` | Option shapes | `.return(...)`-specific options. |
+| `ReturnOptions` | interface | `dist/flow-sdk.d.ts:394-425` | Option shapes | `.return(...)`-specific options. |
 | `rpaWorkflow` | function | `dist/core/actions.d.ts:2766-2810` | Actions | Invoke a deployed RPA (robotic process automation) workflow — a classic UI-automation process, published to… |
 | `RpaWorkflowInputs` | interface | `dist/core/actions.d.ts:975-1012` | Option shapes | 5 field(s) |
-| `SCHEDULE_PRESETS` | const | `dist/flow-sdk.d.ts:81-88` | Flow construction | The eight intervals the designer offers in its Frequency dropdown. |
-| `scheduled` | function | `dist/flow-sdk.d.ts:191-210` | Flow construction | Start the flow on a recurring schedule instead of on demand. |
-| `ScheduledInputs` | interface | `dist/flow-sdk.d.ts:102-114` | Option shapes | 1 field(s) |
-| `ScheduleEvery` | type | `dist/flow-sdk.d.ts:90-101` | Supporting types | How often a scheduled flow runs, as an ISO-8601 repeating interval: `R/` followed by a duration. |
-| `SchedulePreset` | type | `dist/flow-sdk.d.ts:89` | Supporting types |  |
+| `SCHEDULE_PRESETS` | const | `dist/flow-sdk.d.ts:116-123` | Flow construction | The eight intervals the designer offers in its Frequency dropdown. |
+| `scheduled` | function | `dist/flow-sdk.d.ts:226-245` | Flow construction | Start the flow on a recurring schedule instead of on demand. |
+| `ScheduledInputs` | interface | `dist/flow-sdk.d.ts:137-149` | Option shapes | 1 field(s) |
+| `ScheduleEvery` | type | `dist/flow-sdk.d.ts:125-136` | Supporting types | How often a scheduled flow runs, as an ISO-8601 repeating interval: `R/` followed by a duration. |
+| `SchedulePreset` | type | `dist/flow-sdk.d.ts:124` | Supporting types |  |
 | `script` | function | `dist/core/actions.d.ts:2467-2474` | Actions | Declare an inline script action. |
 | `ScriptInputs` | interface | `dist/core/actions.d.ts:149-186` | Option shapes | 2 field(s) |
 | `ScriptReturns` | type | `dist/core/script-return.d.ts:33-38` | Supporting types | What an author may write for `script({ returns })`: the type outright, or — for an object return — the FIELDS, which is… |
@@ -222,16 +222,16 @@ could hand you spans for a version you do not have.
 | `sendMessage` | function | `dist/core/actions.d.ts:2871-2889` | Actions | Post an assistant message into a live conversation (`uipath.conversational.send-message`). |
 | `SendMessageInputs` | interface | `dist/core/actions.d.ts:624-643` | Option shapes | 4 field(s) |
 | `ShownField` | interface | `dist/core/actions.d.ts:338-353` | Supporting types | A value the reviewer READS: shown on the form, filled in from the flow. |
-| `Step` | type | `dist/flow-sdk.d.ts:422-533` | Supporting types |  |
-| `StepList` | class | `dist/flow-sdk.d.ts:674-1096` | Builders | Collects a sequence of steps. |
-| `STICKY_NOTE_COLORS` | const | `dist/flow-sdk.d.ts:564-569` | Flow construction | The designer's sticky-note palette. |
-| `StickyNote` | interface | `dist/flow-sdk.d.ts:576-610` | Supporting types | A canvas sticky note — free text pinned to the diagram, for the humans reading it. |
-| `StickyNoteColor` | type | `dist/flow-sdk.d.ts:570-575` | Supporting types | A sticky note's swatch. |
-| `subflow` | function | `dist/flow-sdk.d.ts:1387-1426` | Flow construction | Run another flow as one step, and read back what it returns. |
+| `Step` | type | `dist/flow-sdk.d.ts:457-568` | Supporting types |  |
+| `StepList` | class | `dist/flow-sdk.d.ts:709-1131` | Builders | Collects a sequence of steps. |
+| `STICKY_NOTE_COLORS` | const | `dist/flow-sdk.d.ts:599-604` | Flow construction | The designer's sticky-note palette. |
+| `StickyNote` | interface | `dist/flow-sdk.d.ts:611-645` | Supporting types | A canvas sticky note — free text pinned to the diagram, for the humans reading it. |
+| `StickyNoteColor` | type | `dist/flow-sdk.d.ts:605-610` | Supporting types | A sticky note's swatch. |
+| `subflow` | function | `dist/flow-sdk.d.ts:1439-1478` | Flow construction | Run another flow as one step, and read back what it returns. |
 | `SubflowSpec` | interface | `dist/flow-sdk.d.ts:33-40` | Supporting types | A step that runs a child flow. |
 | `summarize` | function | `dist/core/actions.d.ts:2573-2613` | Actions | Summarize a document with citations — the platform's **Summarize** node. |
 | `SummarizeInputs` | interface | `dist/core/actions.d.ts:797-829` | Option shapes | 3 field(s) |
-| `SwitchArm` | interface | `dist/flow-sdk.d.ts:294-299` | Supporting types | One arm of a built `.switch` (the serializer's view: body already collected). |
+| `SwitchArm` | interface | `dist/flow-sdk.d.ts:329-334` | Supporting types | One arm of a built `.switch` (the serializer's view: body already collected). |
 | `tmpl` | function | `dist/core/expr.d.ts:253-263` | Expressions and types | Build a JS *string template* (for URLs, messages, etc.). |
 | `ToolRef` | type | `dist/core/actions.d.ts:1643-1652` | Supporting types | One tool on an inline agent — a discriminated union over the kinds the tenant's registry actually serves… |
 | `transform` | function | `dist/core/actions.d.ts:2475-2520` | Actions | Declare a Transform action — a chain of declarative operations over a collection. |
@@ -243,17 +243,17 @@ could hand you spans for a version you do not have.
 | `TriggerDescriptor` | type | `dist/core/connectors.d.ts:130-138` | Generated descriptors | A generated, typed connector-trigger descriptor: TriggerMeta branded with phantom `where`/output types. |
 | `TriggerMeta` | interface | `dist/core/connectors.d.ts:120-129` | Generated descriptors | Runtime metadata a generated trigger descriptor carries. |
 | `TriggerOptions` | interface | `dist/core/actions.d.ts:3389-3436` | Option shapes | The typed `onEvent`/`waitForEvent` options — everything an EventSubscription carries except `connector`/`event`, which… |
-| `TriggerSpec` | type | `dist/flow-sdk.d.ts:115-133` | Supporting types | What starts the flow. |
+| `TriggerSpec` | type | `dist/flow-sdk.d.ts:150-168` | Supporting types | What starts the flow. |
 | `TypeDesc` | type | `dist/core/expr.d.ts:328` | Supporting types |  |
 | `types` | const | `dist/core/expr.d.ts:312-327` | Expressions and types | Variable type descriptors (map to Flow variable `type` values). |
 | `unresolvedLookupMessage` | function | `dist/core/lookups.d.ts:180-189` | Generated descriptors | The message for a lookup nothing has resolved — the command that fixes it. |
 | `v` | function | `dist/core/expr.d.ts:29-41` | Expressions and types | Reference a flow variable or output by name → `$vars.<name>`. |
-| `VarDecl` | interface | `dist/flow-sdk.d.ts:47-57` | Supporting types | 6 field(s) |
-| `VarSpec` | interface | `dist/flow-sdk.d.ts:58-80` | Supporting types | The rich spelling of a variable declaration: pass it instead of a bare `types.*` descriptor wherever `.input()` /… |
+| `VarDecl` | interface | `dist/flow-sdk.d.ts:47-59` | Supporting types | 7 field(s) |
+| `VarSpec` | interface | `dist/flow-sdk.d.ts:60-115` | Supporting types | The rich spelling of a variable declaration: pass it instead of a bare `types.*` descriptor wherever `.input()` /… |
 | `voiceAgent` | function | `dist/core/actions.d.ts:2947-2971` | Actions | Put a VOICE agent on a live call (`uipath.agent.voice`) — it speaks and listens for one turn, then the flow continues. |
 | `VoiceAgentInputs` | interface | `dist/core/actions.d.ts:763-796` | Option shapes | 6 field(s) |
 | `VoiceSettings` | interface | `dist/core/actions.d.ts:740-762` | Supporting types | The audio settings a voice agent speaks with. |
-| `voiceTrigger` | function | `dist/flow-sdk.d.ts:267-291` | Flow construction | Start the flow when a phone call comes IN (`core.trigger.voice`). |
+| `voiceTrigger` | function | `dist/flow-sdk.d.ts:302-326` | Flow construction | Start the flow when a phone call comes IN (`core.trigger.voice`). |
 | `waitForEvent` | function | `dist/core/actions.d.ts:3488-3523` | Actions | Wait mid-flow until a connector event fires, then continue with its payload — the typed form, where a generated trigger… |
 | `waitForEvent` | function | `dist/core/actions.d.ts:3524-3531` | Actions | Stringly form, for an event with no prepared module. |
 | `waitForMessage` | function | `dist/core/actions.d.ts:2890-2906` | Actions | PAUSE until the person sends their next message (`uipath.conversational.wait-for-message`) — a catch event, like… |