@uipath/maestro-builder-sdk 6.20.6 → 6.21.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/api-index.md CHANGED
@@ -41,11 +41,11 @@ could hand you spans for a version you do not have.
41
41
 
42
42
  | Symbol | Kind | Declaration | Area | Summary |
43
43
  | --- | --- | --- | --- | --- |
44
- | `ActionSpec` | type | `dist/core/actions.d.ts:2105-2113` | Supporting types | One action step's spec: `{ kind }` plus that kind's body from FlowActionSpecs, for every kind there. |
45
- | `agent` | function | `dist/core/actions.d.ts:2610-2664` | Actions | Invoke an AGENT resource — either one published to Orchestrator or a sibling agent project registered in the same… |
44
+ | `ActionSpec` | type | `dist/core/actions.d.ts:2025-2033` | Supporting types | One action step's spec: `{ kind }` plus that kind's body from FlowActionSpecs, for every kind there. |
45
+ | `agent` | function | `dist/core/actions.d.ts:2530-2584` | Actions | Invoke an AGENT resource — either one published to Orchestrator or a sibling agent project registered in the same… |
46
46
  | `AgentFlavour` | type | `dist/core/actions.d.ts:1052-1056` | Supporting types | Which KIND of agent project was published behind a `uipath.core.agent.<key>` resource. |
47
47
  | `AgentGuardrail` | type | `dist/core/actions.d.ts:1280` | Supporting types | |
48
- | `agenticProcess` | function | `dist/core/actions.d.ts:2564-2609` | Actions | Invoke a deployed AGENTIC PROCESS — a Maestro process orchestration published to Orchestrator: a BPMN process that… |
48
+ | `agenticProcess` | function | `dist/core/actions.d.ts:2484-2529` | Actions | Invoke a deployed AGENTIC PROCESS — a Maestro process orchestration published to Orchestrator: a BPMN process that… |
49
49
  | `AgenticProcessCompletion` | type | `dist/core/actions.d.ts:1011-1049` | Supporting types | Whether an Agentic Process step waits for the process's result. |
50
50
  | `AgenticProcessInputs` | type | `dist/core/actions.d.ts:1050-1051` | Option shapes | What `agenticProcess()` takes: the shared fields plus the completion policy. |
51
51
  | `AgenticProcessInputsBase` | interface | `dist/core/actions.d.ts:954-1010` | Option shapes | 7 field(s) |
@@ -54,24 +54,24 @@ could hand you spans for a version you do not have.
54
54
  | `AgentMemoryRef` | interface | `dist/core/actions.d.ts:1650-1674` | Supporting types | An episodic memory the agent learns from across runs, wired to the agent's own `memory` handle. |
55
55
  | `Aggregation` | interface | `dist/nodes/transform/flow/spec.d.ts:36-42` | Supporting types | 3 field(s) |
56
56
  | `AggregationOperation` | type | `dist/nodes/transform/flow/spec.d.ts:35` | Supporting types | |
57
- | `apiWorkflow` | function | `dist/core/actions.d.ts:2378-2412` | Actions | Invoke a deployed API workflow — a coded workflow published to Orchestrator, run as a serverless job rather than by a… |
57
+ | `apiWorkflow` | function | `dist/core/actions.d.ts:2298-2332` | Actions | Invoke a deployed API workflow — a coded workflow published to Orchestrator, run as a serverless job rather than by a… |
58
58
  | `ApiWorkflowInputs` | interface | `dist/core/actions.d.ts:887-918` | Option shapes | 5 field(s) |
59
59
  | `AppRef` | interface | `dist/core/actions.d.ts:374-419` | Supporting types | A deployed Action App that supplies a human task's form — the `'action-app'` variant's subject. |
60
- | `ArmBuilder` | class | `dist/flow-sdk.d.ts:1184-1207` | Builders | The sub-builder an ARM callback receives — a `StepList` that can also name itself with `.label(...)`. |
60
+ | `ArmBuilder` | class | `dist/flow-sdk.d.ts:1183-1206` | Builders | The sub-builder an ARM callback receives — a `StepList` that can also name itself with `.label(...)`. |
61
61
  | `AskedField` | interface | `dist/core/actions.d.ts:214-224` | Supporting types | A value the reviewer FILLS IN: read downstream with `out('<step>', '<id>')`. |
62
- | `batchTransform` | function | `dist/core/actions.d.ts:2243-2277` | Actions | Add AI-generated columns to a CSV — the platform's **Batch transform** node, `uipath.pattern.batch-transform` (service… |
62
+ | `batchTransform` | function | `dist/core/actions.d.ts:2163-2197` | Actions | Add AI-generated columns to a CSV — the platform's **Batch transform** node, `uipath.pattern.batch-transform` (service… |
63
63
  | `BatchTransformInputs` | interface | `dist/core/actions.d.ts:714-729` | Option shapes | 4 field(s) |
64
64
  | `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… |
65
- | `BuiltEntryPoint` | interface | `dist/flow-sdk.d.ts:690-702` | Supporting types | One additional flow root, built by `.entryPoint()`. |
66
- | `BuiltFlow` | interface | `dist/flow-sdk.d.ts:703-738` | Supporting types | 15 field(s) |
65
+ | `BuiltEntryPoint` | interface | `dist/flow-sdk.d.ts:691-703` | Supporting types | One additional flow root, built by `.entryPoint()`. |
66
+ | `BuiltFlow` | interface | `dist/flow-sdk.d.ts:704-739` | Supporting types | 15 field(s) |
67
67
  | `BuiltinToolName` | type | `dist/core/actions.d.ts:1542-1543` | Supporting types | The three platform-shipped built-in tools (fixed registry types). |
68
68
  | `BuiltinToolRef` | interface | `dist/core/actions.d.ts:1675-1695` | Supporting types | A platform built-in tool. |
69
69
  | `BuiltInValidatorGuardrail` | interface | `dist/core/actions.d.ts:1238-1279` | Supporting types | A platform-shipped validator, configured by parameters. |
70
- | `CaseValue` | type | `dist/flow-sdk.d.ts:334-335` | Supporting types | A value a `.switch` case compares the discriminant against. |
71
- | `ChildFlow` | type | `dist/flow-sdk.d.ts:50-53` | Supporting types | Anything `subflow()` accepts as the child: a builder, or an already-built flow. |
70
+ | `CaseValue` | type | `dist/flow-sdk.d.ts:335-336` | Supporting types | A value a `.switch` case compares the discriminant against. |
71
+ | `ChildFlow` | type | `dist/flow-sdk.d.ts:51-54` | Supporting types | Anything `subflow()` accepts as the child: a builder, or an already-built flow. |
72
72
  | `ClientSideToolRef` | interface | `dist/core/actions.d.ts:1604-1619` | Supporting types | A CLIENT-side tool: the agent asks the CALLING application to run it and hand the answer back… |
73
- | `connector` | function | `dist/core/actions.d.ts:2762-2785` | Actions | Declare an Integration Service connector action — the typed form, where a generated descriptor supplies the nodeType and… |
74
- | `connector` | function | `dist/core/actions.d.ts:2786-2802` | Actions | Stringly form, for a connector with no prepared module — `connector('uipath-salesforce-slack',… |
73
+ | `connector` | function | `dist/core/actions.d.ts:2636-2659` | Actions | Declare an Integration Service connector action — the typed form, where a generated descriptor supplies the nodeType and… |
74
+ | `connector` | function | `dist/core/actions.d.ts:2660-2676` | Actions | Stringly form, for a connector with no prepared module — `connector('uipath-salesforce-slack',… |
75
75
  | `ConnectorDescriptor` | type | `dist/core/connectors.d.ts:89-97` | Generated descriptors | A generated, typed connector descriptor: ConnectorMeta branded with phantom input/output types. |
76
76
  | `ConnectorLookupValue` | type | `dist/core/connectors.d.ts:50-59` | Generated descriptors | ConnectorValue for a field that also accepts an unresolved lookup. |
77
77
  | `ConnectorMeta` | interface | `dist/core/connectors.d.ts:60-88` | Generated descriptors | Runtime metadata a generated descriptor carries. |
@@ -81,13 +81,13 @@ could hand you spans for a version you do not have.
81
81
  | `ContextIndexRef` | interface | `dist/core/actions.d.ts:1884-1918` | Supporting types | One Context Grounding index an inline agent is grounded on. |
82
82
  | `ContributionContext` | interface | `dist/core/node-classes.d.ts:68-79` | Supporting types | What the serializer tells a contributor before asking for its contribution. |
83
83
  | `ContributionDiagnostic` | interface | `dist/core/node-classes.d.ts:22-33` | Supporting types | A diagnostic a node contributes during `check` — surfaced alongside the built-in rules with the same severities. |
84
- | `conversationalAgent` | function | `dist/core/actions.d.ts:2539-2563` | Actions | A CONVERSATIONAL agent (`uipath.agent.conversational`) — it answers one turn of a live chat, reading the transcript… |
84
+ | `conversationalAgent` | function | `dist/core/actions.d.ts:2459-2483` | Actions | A CONVERSATIONAL agent (`uipath.agent.conversational`) — it answers one turn of a live chat, reading the transcript… |
85
85
  | `ConversationalAgentInputs` | interface | `dist/core/actions.d.ts:553-599` | Option shapes | 10 field(s) |
86
86
  | `ConversationalAgentSettings` | interface | `dist/core/actions.d.ts:529-552` | Supporting types | How a conversational agent gets its turn — the node's own `conversationalAgentSettings` sub-object. |
87
- | `conversationContext` | function | `dist/core/actions.d.ts:2474-2488` | Actions | READ a conversation's transcript so far without waiting (`uipath.conversational.get-conversation-context`) — the shape a… |
87
+ | `conversationContext` | function | `dist/core/actions.d.ts:2394-2408` | Actions | READ a conversation's transcript so far without waiting (`uipath.conversational.get-conversation-context`) — the shape a… |
88
88
  | `ConversationContextInputs` | interface | `dist/core/actions.d.ts:521-528` | Option shapes | 2 field(s) |
89
- | `conversationTrigger` | function | `dist/flow-sdk.d.ts:282-308` | Flow construction | Start the flow when a new CONVERSATION is created (`core.trigger.conversation`) — the entry point for a chat-driven… |
90
- | `createOutgoingCall` | function | `dist/core/actions.d.ts:2489-2505` | Actions | Place an outgoing phone call (`uipath.conversational.voice.create-outgoing-call`) and get back the `callContext` every… |
89
+ | `conversationTrigger` | function | `dist/flow-sdk.d.ts:283-309` | Flow construction | Start the flow when a new CONVERSATION is created (`core.trigger.conversation`) — the entry point for a chat-driven… |
90
+ | `createOutgoingCall` | function | `dist/core/actions.d.ts:2409-2425` | Actions | Place an outgoing phone call (`uipath.conversational.voice.create-outgoing-call`) and get back the `callContext` every… |
91
91
  | `CreateOutgoingCallInputs` | interface | `dist/core/actions.d.ts:600-608` | Option shapes | 2 field(s) |
92
92
  | `CustomGuardrail` | interface | `dist/core/actions.d.ts:1225-1237` | Supporting types | A rule-based guardrail you author in place. |
93
93
  | `dataFabricCreate` | function | `dist/nodes/data-fabric/flow/factories.d.ts:56-79` | Actions | Create an entity record in Data Fabric (`core.datafabric.create`). |
@@ -111,60 +111,60 @@ could hand you spans for a version you do not have.
111
111
  | `documentClassify` | function | `dist/nodes/document/flow/factories.d.ts:8-16` | Actions | Classify a document into a document type (`uipath.document.classify`). |
112
112
  | `DocumentClassifyInputs` | interface | `dist/nodes/document/flow/spec.d.ts:9-18` | Option shapes | 4 field(s) |
113
113
  | `DocValidationInputs` | interface | `dist/core/actions.d.ts:304-327` | Option shapes | The Document Validation task's subject — `variant: 'document-validation'` only. |
114
- | `DoWhileOptions` | interface | `dist/flow-sdk.d.ts:469-478` | Option shapes | Do-while options. |
114
+ | `DoWhileOptions` | interface | `dist/flow-sdk.d.ts:470-479` | Option shapes | Do-while options. |
115
115
  | `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… |
116
116
  | `DynamicExtractInputs` | interface | `dist/nodes/document/flow/spec.d.ts:19-53` | Option shapes | 5 field(s) |
117
- | `EdgeRoute` | interface | `dist/flow-sdk.d.ts:614-628` | Supporting types | One edge's route: user-dragged bends and/or the auto-router's waypoints. |
118
- | `endCall` | function | `dist/core/actions.d.ts:2506-2513` | Actions | Hang up (`uipath.conversational.voice.end-call`). |
117
+ | `EdgeRoute` | interface | `dist/flow-sdk.d.ts:615-629` | Supporting types | One edge's route: user-dragged bends and/or the auto-router's waypoints. |
118
+ | `endCall` | function | `dist/core/actions.d.ts:2426-2433` | Actions | Hang up (`uipath.conversational.voice.end-call`). |
119
119
  | `EndCallInputs` | interface | `dist/core/actions.d.ts:609-616` | Option shapes | 1 field(s) |
120
120
  | `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` —… |
121
121
  | `err` | function | `dist/core/expr.d.ts:153-246` | Expressions and types | Reference a FAILED step's error → `$vars.<step>.error[.<field>]`. |
122
122
  | `ErrorEnvelopeField` | type | `dist/core/expr.d.ts:142-152` | Supporting types | The fields a failure envelope carries. |
123
123
  | `EscalationRef` | interface | `dist/core/actions.d.ts:1817-1883` | Supporting types | One escalation an inline agent may raise — an Action Center app task a human completes (the `coded-action-app` variant,… |
124
- | `EventFilter` | type | `dist/core/actions.d.ts:2803-2844` | Supporting types | One filter condition on the event payload. |
125
- | `EventSubscription` | interface | `dist/core/actions.d.ts:2893-2934` | Option shapes | What a connector event subscribes to. |
124
+ | `EventFilter` | type | `dist/core/actions.d.ts:2677-2718` | Supporting types | One filter condition on the event payload. |
125
+ | `EventSubscription` | interface | `dist/core/actions.d.ts:2767-2808` | Option shapes | What a connector event subscribes to. |
126
126
  | `Expr` | class | `dist/core/expr.d.ts:11-21` | Supporting types | A Flow expression. |
127
127
  | `FieldMapping` | interface | `dist/nodes/transform/flow/spec.d.ts:27-34` | Supporting types | 3 field(s) |
128
128
  | `FilterCondition` | type | `dist/nodes/transform/flow/spec.d.ts:10-11` | Supporting types | Comparison a filter rule applies to a field. |
129
129
  | `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. |
130
130
  | `FilterRule` | interface | `dist/nodes/transform/flow/spec.d.ts:12-24` | Supporting types | 3 field(s) |
131
- | `flow` | function | `dist/flow-sdk.d.ts:1490-1505` | Flow construction | Start building a flow with the given id. |
131
+ | `flow` | function | `dist/flow-sdk.d.ts:1489-1504` | Flow construction | Start building a flow with the given id. |
132
132
  | `FlowAction` | class | `dist/core/node-classes.d.ts:162-168` | Supporting types | A node placed as a step — pass an instance to `.step(name, …)`. |
133
- | `FlowActionSpec` | type | `dist/flow-sdk.d.ts:48-49` | Supporting types | What `.step()` accepts here: the shared actions plus this SDK's subflow. |
134
- | `FlowActionSpecs` | interface | `dist/core/actions.d.ts:1995-2104` | Supporting types | Every action kind, keyed by kind, to the body of its spec — the arm's fields other than `kind`. |
135
- | `FlowBuilder` | class | `dist/flow-sdk.d.ts:1208-1489` | Builders | 13 member(s) |
136
- | `FlowLayout` | interface | `dist/flow-sdk.d.ts:676-689` | Supporting types | Designer layout for a flow, keyed by AUTHOR-level ids: node entries by step name (plus the trigger id and `end`), edge… |
133
+ | `FlowActionSpec` | type | `dist/flow-sdk.d.ts:49-50` | Supporting types | What `.step()` accepts here: the shared actions plus this SDK's subflow. |
134
+ | `FlowActionSpecs` | interface | `dist/core/actions.d.ts:1919-2024` | Supporting types | Every action kind, keyed by kind, to the body of its spec — the arm's fields other than `kind`. |
135
+ | `FlowBuilder` | class | `dist/flow-sdk.d.ts:1207-1488` | Builders | 13 member(s) |
136
+ | `FlowLayout` | interface | `dist/flow-sdk.d.ts:677-690` | Supporting types | Designer layout for a flow, keyed by AUTHOR-level ids: node entries by step name (plus the trigger id and `end`), edge… |
137
137
  | `FlowNode` | class | `dist/core/node-classes.d.ts:126-161` | Supporting types | The abstract root of every definition-backed node the builder can place. |
138
138
  | `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. |
139
139
  | `FlowTrigger` | class | `dist/core/node-classes.d.ts:169-175` | Supporting types | A node that starts the flow — pass an instance to `.trigger(…)`. |
140
140
  | `FormField` | type | `dist/core/actions.d.ts:243` | Supporting types | |
141
141
  | `FormFieldType` | type | `dist/core/actions.d.ts:192-197` | Supporting types | A form field's type. |
142
- | `formTrigger` | function | `dist/flow-sdk.d.ts:253-281` | Flow construction | Start the flow from a FORM a person fills in (`core.trigger.form`) — the platform renders one field per flow input and… |
142
+ | `formTrigger` | function | `dist/flow-sdk.d.ts:254-282` | Flow construction | Start the flow from a FORM a person fills in (`core.trigger.form`) — the platform renders one field per flow input and… |
143
143
  | `GuardrailAction` | type | `dist/core/actions.d.ts:1214-1224` | Supporting types | What happens when a guardrail trips. |
144
144
  | `GuardrailFieldReference` | interface | `dist/core/actions.d.ts:1181-1186` | Supporting types | A field the rule or filter action points at. |
145
145
  | `GuardrailFieldSelector` | type | `dist/core/actions.d.ts:1187-1193` | Supporting types | All fields, or a named few. |
146
146
  | `GuardrailRule` | type | `dist/core/actions.d.ts:1194-1213` | Supporting types | One condition of a custom guardrail. |
147
147
  | `GuardrailScope` | type | `dist/core/actions.d.ts:1173-1174` | Supporting types | Where a guardrail applies: the whole agent, its LLM calls, or its tools. |
148
148
  | `GuardrailSelector` | interface | `dist/core/actions.d.ts:1175-1180` | Supporting types | Which artifacts inside the scope the guardrail watches. |
149
- | `hitl` | function | `dist/core/actions.d.ts:2150-2201` | Actions | Declare a human task — a step that pauses for a person to read some values, fill others in, and press one of the outcome… |
149
+ | `hitl` | function | `dist/core/actions.d.ts:2070-2121` | Actions | Declare a human task — a step that pauses for a person to read some values, fill others in, and press one of the outcome… |
150
150
  | `HitlAssigneeType` | type | `dist/core/actions.d.ts:250-257` | Supporting types | How the task is assigned, the platform's own vocabulary (canvas `HITL_ASSIGNEE_TYPE`): `'user'` a single user, `'group'`… |
151
151
  | `HitlChannel` | type | `dist/core/actions.d.ts:244-249` | Supporting types | Where the task is delivered. |
152
152
  | `HitlConnection` | interface | `dist/core/actions.d.ts:258-266` | Supporting types | A per-channel Integration Service connection (Slack / Teams delivery). |
153
153
  | `HitlInputs` | interface | `dist/core/actions.d.ts:420-491` | Option shapes | 11 field(s) |
154
154
  | `HitlRecipient` | interface | `dist/core/actions.d.ts:267-303` | Supporting types | Who gets the task and over which channels. |
155
155
  | `HitlVariant` | type | `dist/core/actions.d.ts:348-373` | Supporting types | WHICH human-task node type to emit. |
156
- | `http` | function | `dist/core/actions.d.ts:2142-2149` | Actions | Declare an HTTP request action, explicitly choosing standalone or managed. |
156
+ | `http` | function | `dist/core/actions.d.ts:2062-2069` | Actions | Declare an HTTP request action, explicitly choosing standalone or managed. |
157
157
  | `HttpBranch` | interface | `dist/core/actions.d.ts:13-28` | Supporting types | One conditional response branch on an HTTP node — a designer-visible side exit. |
158
158
  | `HttpInputs` | type | `dist/core/actions.d.ts:130-147` | Option shapes | |
159
159
  | `HttpInputsBase` | interface | `dist/core/actions.d.ts:29-129` | Option shapes | 11 field(s) |
160
160
  | `HttpRequestToolRef` | interface | `dist/core/actions.d.ts:1620-1649` | Supporting types | The built-in HTTP-request tool (`uipath.agent.resource.tool.builtin.httprequest`): the agent performs an HTTP call. |
161
- | `inlineAgent` | function | `dist/core/actions.d.ts:2665-2715` | Actions | Declare an INLINE AUTONOMOUS AGENT — an agent defined inside this flow's own project rather than published to… |
161
+ | `inlineAgent` | function | `dist/core/actions.d.ts:2585-2635` | Actions | Declare an INLINE AUTONOMOUS AGENT — an agent defined inside this flow's own project rather than published to… |
162
162
  | `InlineAgentFieldType` | type | `dist/core/actions.d.ts:1153-1154` | Supporting types | A JSON-schema-ish type for one field of an inline agent's input/output schema. |
163
163
  | `InlineAgentInputs` | interface | `dist/core/actions.d.ts:1281-1541` | Option shapes | 16 field(s) |
164
164
  | `InOutField` | interface | `dist/core/actions.d.ts:225-242` | Supporting types | A value the reviewer READS **and can correct**: pre-filled from the flow, editable on the form, and the (possibly… |
165
165
  | `input` | function | `dist/core/expr.d.ts:44-61` | Expressions and types | Reference a flow input by name → `$vars.<triggerId>.output.<name>`. |
166
166
  | `isLookupToken` | function | `dist/core/lookups.d.ts:53-54` | Generated descriptors | True when `v` is an unresolved LookupToken. |
167
- | `ixpExtract` | function | `dist/core/actions.d.ts:2278-2332` | Actions | Extract fields from a document with a published IxP project — the platform's **Extract** node (`uipath.ixp.*`, service… |
167
+ | `ixpExtract` | function | `dist/core/actions.d.ts:2198-2252` | Actions | Extract fields from a document with a published IxP project — the platform's **Extract** node (`uipath.ixp.*`, service… |
168
168
  | `IxpExtractInputs` | interface | `dist/core/actions.d.ts:747-821` | Option shapes | 9 field(s) |
169
169
  | `IxpToolRef` | interface | `dist/core/actions.d.ts:1778-1816` | Supporting types | A published IxP (Intelligent eXtraction Platform) project as a tool — the agent decides when to extract a document and… |
170
170
  | `js` | function | `dist/core/expr.d.ts:247-282` | Expressions and types | Build a raw JS *expression* (a condition or computation). |
@@ -181,27 +181,27 @@ could hand you spans for a version you do not have.
181
181
  | `lookupSpecOf` | function | `dist/core/lookups.d.ts:199-206` | Generated descriptors | The LookupSpec for one field, or `undefined` when it earns no helper. |
182
182
  | `LookupStrategy` | type | `dist/core/lookups.d.ts:1-10` | Generated descriptors | How `prepare` should retrieve the collection, chosen from the metadata. |
183
183
  | `LookupToken` | interface | `dist/core/lookups.d.ts:37-52` | Generated descriptors | An unresolved lookup: what `.byEmail(…)` returns. |
184
- | `LoopOptions` | interface | `dist/flow-sdk.d.ts:448-468` | Option shapes | Loop-specific options. |
185
- | `manual` | function | `dist/flow-sdk.d.ts:176-185` | Flow construction | The manual trigger, explicitly. |
184
+ | `LoopOptions` | interface | `dist/flow-sdk.d.ts:449-469` | Option shapes | Loop-specific options. |
185
+ | `manual` | function | `dist/flow-sdk.d.ts:177-186` | Flow construction | The manual trigger, explicitly. |
186
186
  | `McpToolRef` | interface | `dist/core/actions.d.ts:1554-1582` | Supporting types | An MCP server the agent may call tools on. |
187
187
  | `mock` | function | `dist/nodes/mock/flow/factories.d.ts:6-45` | Actions | Declare a PLACEHOLDER step — "a real node goes here later". |
188
188
  | `NodeContribution` | interface | `dist/core/node-classes.d.ts:102-125` | Supporting types | One validated construct, returned by FlowNode.contribute. |
189
- | `NodeLayout` | interface | `dist/flow-sdk.d.ts:599-613` | Supporting types | One node's designer layout: canvas position, and optionally size and collapsed state. |
190
- | `NodeOptions` | interface | `dist/flow-sdk.d.ts:362-415` | Option shapes | Options shared by every builder method that creates a definition-backed node: `version` selects the exact node… |
191
- | `onEvent` | function | `dist/flow-sdk.d.ts:186-224` | Flow construction | Start the flow when a connector event fires — e.g. an email arriving in a mailbox folder. |
192
- | `onEvent` | function | `dist/flow-sdk.d.ts:225-232` | Flow construction | Stringly form, for an event with no prepared module. |
189
+ | `NodeLayout` | interface | `dist/flow-sdk.d.ts:600-614` | Supporting types | One node's designer layout: canvas position, and optionally size and collapsed state. |
190
+ | `NodeOptions` | interface | `dist/flow-sdk.d.ts:363-416` | Option shapes | Options shared by every builder method that creates a definition-backed node: `version` selects the exact node… |
191
+ | `onEvent` | function | `dist/flow-sdk.d.ts:187-225` | Flow construction | Start the flow when a connector event fires — e.g. an email arriving in a mailbox folder. |
192
+ | `onEvent` | function | `dist/flow-sdk.d.ts:226-233` | Flow construction | Stringly form, for an event with no prepared module. |
193
193
  | `out` | function | `dist/core/expr.d.ts:73-94` | Expressions and types | Reference an upstream step's output → `$vars.<step>.output[.<path>]`. |
194
194
  | `Outcome` | type | `dist/core/actions.d.ts:328-347` | Supporting types | One completion button. |
195
195
  | `OutputColumn` | interface | `dist/core/actions.d.ts:707-713` | Supporting types | One column Batch Transform appends to the CSV. |
196
- | `PortArm` | interface | `dist/flow-sdk.d.ts:349-361` | Supporting types | One arm of a built `.stepSwitch` — the same shape as SwitchArm, but `value` names an exit the ACTION declares (a… |
196
+ | `PortArm` | interface | `dist/flow-sdk.d.ts:350-362` | Supporting types | One arm of a built `.stepSwitch` — the same shape as SwitchArm, but `value` names an exit the ACTION declares (a… |
197
197
  | `ProcessLocation` | type | `dist/core/actions.d.ts:822-827` | Supporting types | Where a process resource lives: deployed to an Orchestrator folder (`'published'`, the default) or a sibling project of… |
198
198
  | `ProcessToolKind` | type | `dist/core/actions.d.ts:1734-1747` | Supporting types | The tool kinds that wrap a DEPLOYED tenant resource. |
199
199
  | `ProcessToolRef` | interface | `dist/core/actions.d.ts:1748-1777` | Supporting types | A deployed tenant resource the agent may invoke. |
200
- | `publishedFunction` | function | `dist/core/actions.d.ts:2413-2437` | Actions | Invoke a published Orchestrator **Function** — a deployed unit of code run as one step (`uipath.core.function.<key>`,… |
200
+ | `publishedFunction` | function | `dist/core/actions.d.ts:2333-2357` | Actions | Invoke a published Orchestrator **Function** — a deployed unit of code run as one step (`uipath.core.function.<key>`,… |
201
201
  | `PublishedFunctionInputs` | interface | `dist/core/actions.d.ts:919-953` | Option shapes | A published Orchestrator **Function** — a small, single-purpose unit of code deployed as its own resource and invoked as… |
202
- | `queueItem` | function | `dist/core/actions.d.ts:2716-2761` | Actions | Declare an Orchestrator QUEUE ITEM step. |
203
- | `QueueItemInputs` | interface | `dist/core/actions.d.ts:1921-1994` | Option shapes | 10 field(s) |
204
- | `QueuePriority` | type | `dist/core/actions.d.ts:1919-1920` | Supporting types | The three priorities an Orchestrator queue item can carry. |
202
+ | `queueItem` | function | `dist/nodes/queue/flow/factories.d.ts:4-49` | Actions | Declare an Orchestrator QUEUE ITEM step. |
203
+ | `QueueItemInputs` | interface | `dist/nodes/queue/flow/spec.d.ts:11-84` | Option shapes | 10 field(s) |
204
+ | `QueuePriority` | type | `dist/nodes/queue/flow/spec.d.ts:9-10` | Supporting types | The three priorities an Orchestrator queue item can carry. |
205
205
  | `ran` | function | `dist/core/expr.d.ts:95-141` | Expressions and types | Did this step run? |
206
206
  | `rawNode` | function | `dist/raw-node.d.ts:9-71` | Supporting types | Place a node this SDK has no factory for, carrying its definition verbatim (`uipath.exotic.thing@2.1` and the manifest… |
207
207
  | `RawReference` | type | `dist/core/lookups.d.ts:190-198` | Supporting types | |
@@ -209,31 +209,31 @@ could hand you spans for a version you do not have.
209
209
  | `resolvedValue` | function | `dist/core/lookups.d.ts:172-179` | Generated descriptors | The recorded id for a token, or `undefined`. |
210
210
  | `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… |
211
211
  | `ReturnFieldType` | type | `dist/core/actions.d.ts:1155-1172` | Supporting types | A JSON-schema-ish type for one field of a step's declared `returns`. |
212
- | `ReturnOptions` | interface | `dist/flow-sdk.d.ts:416-447` | Option shapes | `.return(...)`-specific options. |
213
- | `rpaWorkflow` | function | `dist/core/actions.d.ts:2333-2377` | Actions | Invoke a deployed RPA (robotic process automation) workflow — a classic UI-automation process, published to… |
212
+ | `ReturnOptions` | interface | `dist/flow-sdk.d.ts:417-448` | Option shapes | `.return(...)`-specific options. |
213
+ | `rpaWorkflow` | function | `dist/core/actions.d.ts:2253-2297` | Actions | Invoke a deployed RPA (robotic process automation) workflow — a classic UI-automation process, published to… |
214
214
  | `RpaWorkflowInputs` | interface | `dist/core/actions.d.ts:828-886` | Option shapes | 7 field(s) |
215
- | `SCHEDULE_PRESETS` | const | `dist/flow-sdk.d.ts:123-130` | Flow construction | The eight intervals the designer offers in its Frequency dropdown. |
216
- | `scheduled` | function | `dist/flow-sdk.d.ts:233-252` | Flow construction | Start the flow on a recurring schedule instead of on demand. |
217
- | `ScheduledInputs` | interface | `dist/flow-sdk.d.ts:144-156` | Option shapes | 1 field(s) |
218
- | `ScheduleEvery` | type | `dist/flow-sdk.d.ts:132-143` | Supporting types | How often a scheduled flow runs, as an ISO-8601 repeating interval: `R/` followed by a duration. |
219
- | `SchedulePreset` | type | `dist/flow-sdk.d.ts:131` | Supporting types | |
215
+ | `SCHEDULE_PRESETS` | const | `dist/flow-sdk.d.ts:124-131` | Flow construction | The eight intervals the designer offers in its Frequency dropdown. |
216
+ | `scheduled` | function | `dist/flow-sdk.d.ts:234-253` | Flow construction | Start the flow on a recurring schedule instead of on demand. |
217
+ | `ScheduledInputs` | interface | `dist/flow-sdk.d.ts:145-157` | Option shapes | 1 field(s) |
218
+ | `ScheduleEvery` | type | `dist/flow-sdk.d.ts:133-144` | Supporting types | How often a scheduled flow runs, as an ISO-8601 repeating interval: `R/` followed by a duration. |
219
+ | `SchedulePreset` | type | `dist/flow-sdk.d.ts:132` | Supporting types | |
220
220
  | `script` | function | `dist/nodes/script/flow/factories.d.ts:7-14` | Actions | Declare an inline script action. |
221
221
  | `ScriptInputs` | interface | `dist/nodes/script/flow/spec.d.ts:7-44` | Option shapes | 2 field(s) |
222
222
  | `ScriptReturns` | type | `dist/core/script-return.d.ts:42-48` | Supporting types | What an author may write for `script({ returns })`: the type outright, or — for an object return — the FIELDS, which is… |
223
223
  | `ScriptReturnType` | type | `dist/core/script-return.d.ts:31-41` | Supporting types | The vocabulary a script's output can be declared as. |
224
- | `sendMessage` | function | `dist/core/actions.d.ts:2438-2456` | Actions | Post an assistant message into a live conversation (`uipath.conversational.send-message`). |
224
+ | `sendMessage` | function | `dist/core/actions.d.ts:2358-2376` | Actions | Post an assistant message into a live conversation (`uipath.conversational.send-message`). |
225
225
  | `SendMessageInputs` | interface | `dist/core/actions.d.ts:492-511` | Option shapes | 4 field(s) |
226
226
  | `ShownField` | interface | `dist/core/actions.d.ts:198-213` | Supporting types | A value the reviewer READS: shown on the form, filled in from the flow. |
227
- | `Step` | type | `dist/flow-sdk.d.ts:479-598` | Supporting types | |
228
- | `StepList` | class | `dist/flow-sdk.d.ts:739-1183` | Builders | Collects a sequence of steps. |
229
- | `STICKY_NOTE_COLORS` | const | `dist/flow-sdk.d.ts:629-634` | Flow construction | The designer's sticky-note palette. |
230
- | `StickyNote` | interface | `dist/flow-sdk.d.ts:641-675` | Supporting types | A canvas sticky note — free text pinned to the diagram, for the humans reading it. |
231
- | `StickyNoteColor` | type | `dist/flow-sdk.d.ts:635-640` | Supporting types | A sticky note's swatch. |
232
- | `subflow` | function | `dist/flow-sdk.d.ts:1506-1545` | Flow construction | Run another flow as one step, and read back what it returns. |
233
- | `SubflowSpec` | interface | `dist/flow-sdk.d.ts:40-47` | Supporting types | A step that runs a child flow. |
234
- | `summarize` | function | `dist/core/actions.d.ts:2202-2242` | Actions | Summarize a document with citations — the platform's **Summarize** node. |
227
+ | `Step` | type | `dist/flow-sdk.d.ts:480-599` | Supporting types | |
228
+ | `StepList` | class | `dist/flow-sdk.d.ts:740-1182` | Builders | Collects a sequence of steps. |
229
+ | `STICKY_NOTE_COLORS` | const | `dist/flow-sdk.d.ts:630-635` | Flow construction | The designer's sticky-note palette. |
230
+ | `StickyNote` | interface | `dist/flow-sdk.d.ts:642-676` | Supporting types | A canvas sticky note — free text pinned to the diagram, for the humans reading it. |
231
+ | `StickyNoteColor` | type | `dist/flow-sdk.d.ts:636-641` | Supporting types | A sticky note's swatch. |
232
+ | `subflow` | function | `dist/flow-sdk.d.ts:1505-1544` | Flow construction | Run another flow as one step, and read back what it returns. |
233
+ | `SubflowSpec` | interface | `dist/flow-sdk.d.ts:41-48` | Supporting types | A step that runs a child flow. |
234
+ | `summarize` | function | `dist/core/actions.d.ts:2122-2162` | Actions | Summarize a document with citations — the platform's **Summarize** node. |
235
235
  | `SummarizeInputs` | interface | `dist/core/actions.d.ts:674-706` | Option shapes | 3 field(s) |
236
- | `SwitchArm` | interface | `dist/flow-sdk.d.ts:336-348` | Supporting types | One arm of a built `.switch` (the serializer's view: body already collected). |
236
+ | `SwitchArm` | interface | `dist/flow-sdk.d.ts:337-349` | Supporting types | One arm of a built `.switch` (the serializer's view: body already collected). |
237
237
  | `tmpl` | function | `dist/core/expr.d.ts:283-293` | Expressions and types | Build a JS *string template* (for URLs, messages, etc.). |
238
238
  | `ToolRef` | type | `dist/core/actions.d.ts:1544-1553` | Supporting types | One tool on an inline agent — a discriminated union over the kinds the tenant's registry actually serves… |
239
239
  | `transform` | function | `dist/nodes/transform/flow/factories.d.ts:7-52` | Actions | Declare a Transform action — a chain of declarative operations over a collection. |
@@ -244,21 +244,21 @@ could hand you spans for a version you do not have.
244
244
  | `triggerDescriptor` | function | `dist/core/connectors.d.ts:139-151` | Generated descriptors | Brand a trigger descriptor literal with its where/output types. |
245
245
  | `TriggerDescriptor` | type | `dist/core/connectors.d.ts:130-138` | Generated descriptors | A generated, typed connector-trigger descriptor: TriggerMeta branded with phantom `where`/output types. |
246
246
  | `TriggerMeta` | interface | `dist/core/connectors.d.ts:120-129` | Generated descriptors | Runtime metadata a generated trigger descriptor carries. |
247
- | `TriggerOptions` | interface | `dist/core/actions.d.ts:2845-2892` | Option shapes | The typed `onEvent`/`waitForEvent` options — everything an EventSubscription carries except `connector`/`event`, which… |
248
- | `TriggerSpec` | type | `dist/flow-sdk.d.ts:157-175` | Supporting types | What starts the flow. |
247
+ | `TriggerOptions` | interface | `dist/core/actions.d.ts:2719-2766` | Option shapes | The typed `onEvent`/`waitForEvent` options — everything an EventSubscription carries except `connector`/`event`, which… |
248
+ | `TriggerSpec` | type | `dist/flow-sdk.d.ts:158-176` | Supporting types | What starts the flow. |
249
249
  | `TypeDesc` | type | `dist/core/expr.d.ts:385` | Supporting types | |
250
250
  | `types` | const | `dist/core/expr.d.ts:369-384` | Expressions and types | Variable type descriptors (map to Flow variable `type` values). |
251
251
  | `unresolvedLookupMessage` | function | `dist/core/lookups.d.ts:180-189` | Generated descriptors | The message for a lookup nothing has resolved — the command that fixes it. |
252
252
  | `v` | function | `dist/core/expr.d.ts:29-41` | Expressions and types | Reference a flow variable or output by name → `$vars.<name>`. |
253
- | `VarDecl` | interface | `dist/flow-sdk.d.ts:54-66` | Supporting types | 7 field(s) |
254
- | `VarSpec` | interface | `dist/flow-sdk.d.ts:67-122` | Supporting types | The rich spelling of a variable declaration: pass it instead of a bare `types.*` descriptor wherever `.input()` /… |
255
- | `voiceAgent` | function | `dist/core/actions.d.ts:2514-2538` | Actions | Put a VOICE agent on a live call (`uipath.agent.voice`) — it speaks and listens for one turn, then the flow continues. |
253
+ | `VarDecl` | interface | `dist/flow-sdk.d.ts:55-67` | Supporting types | 7 field(s) |
254
+ | `VarSpec` | interface | `dist/flow-sdk.d.ts:68-123` | Supporting types | The rich spelling of a variable declaration: pass it instead of a bare `types.*` descriptor wherever `.input()` /… |
255
+ | `voiceAgent` | function | `dist/core/actions.d.ts:2434-2458` | Actions | Put a VOICE agent on a live call (`uipath.agent.voice`) — it speaks and listens for one turn, then the flow continues. |
256
256
  | `VoiceAgentInputs` | interface | `dist/core/actions.d.ts:640-673` | Option shapes | 6 field(s) |
257
257
  | `VoiceSettings` | interface | `dist/core/actions.d.ts:617-639` | Supporting types | The audio settings a voice agent speaks with. |
258
- | `voiceTrigger` | function | `dist/flow-sdk.d.ts:309-333` | Flow construction | Start the flow when a phone call comes IN (`core.trigger.voice`). |
259
- | `waitForEvent` | function | `dist/core/actions.d.ts:2944-2979` | Actions | Wait mid-flow until a connector event fires, then continue with its payload — the typed form, where a generated trigger… |
260
- | `waitForEvent` | function | `dist/core/actions.d.ts:2980-2987` | Actions | Stringly form, for an event with no prepared module. |
261
- | `waitForMessage` | function | `dist/core/actions.d.ts:2457-2473` | Actions | PAUSE until the person sends their next message (`uipath.conversational.wait-for-message`) — a catch event, like… |
258
+ | `voiceTrigger` | function | `dist/flow-sdk.d.ts:310-334` | Flow construction | Start the flow when a phone call comes IN (`core.trigger.voice`). |
259
+ | `waitForEvent` | function | `dist/core/actions.d.ts:2818-2853` | Actions | Wait mid-flow until a connector event fires, then continue with its payload — the typed form, where a generated trigger… |
260
+ | `waitForEvent` | function | `dist/core/actions.d.ts:2854-2861` | Actions | Stringly form, for an event with no prepared module. |
261
+ | `waitForMessage` | function | `dist/core/actions.d.ts:2377-2393` | Actions | PAUSE until the person sends their next message (`uipath.conversational.wait-for-message`) — a catch event, like… |
262
262
  | `WaitForMessageInputs` | interface | `dist/core/actions.d.ts:512-520` | Option shapes | 2 field(s) |
263
263
 
264
264
  ## `@uipath/maestro-builder-sdk/case`
@@ -301,8 +301,8 @@ could hand you spans for a version you do not have.
301
301
  | `EscalationOpts` | interface | `dist/case/case-sdk.d.ts:127-139` | Option shapes | 4 field(s) |
302
302
  | `EscalationRecipient` | interface | `dist/case/case-sdk.d.ts:119-126` | Supporting types | Who an escalation notifies. |
303
303
  | `EscalationTrigger` | type | `dist/case/case-sdk.d.ts:117-118` | Supporting types | When an escalation fires: as the deadline approaches (`at-risk`) or once it passes (`sla-breached`). |
304
- | `EventFilter` | type | `dist/core/actions.d.ts:2803-2844` | Supporting types | One filter condition on the event payload. |
305
- | `EventSubscription` | interface | `dist/core/actions.d.ts:2893-2934` | Option shapes | What a connector event subscribes to. |
304
+ | `EventFilter` | type | `dist/core/actions.d.ts:2677-2718` | Supporting types | One filter condition on the event payload. |
305
+ | `EventSubscription` | interface | `dist/core/actions.d.ts:2767-2808` | Option shapes | What a connector event subscribes to. |
306
306
  | `eventTrigger` | function | `dist/case/case-sdk.d.ts:276-286` | Case authoring | An Integration Service **event** trigger — an external event (a new row, an email, a webhook) starts the case. |
307
307
  | `eventTrigger` | function | `dist/case/case-sdk.d.ts:287-293` | Case authoring | An Integration Service event trigger in placeholder or stringly-resolved form. |
308
308
  | `EventTriggerOpts` | interface | `dist/case/case-sdk.d.ts:239-263` | Option shapes | 4 field(s) |
@@ -338,7 +338,7 @@ could hand you spans for a version you do not have.
338
338
  | `toUser` | function | `dist/case/case-sdk.d.ts:150-157` | Case authoring | An escalation recipient that is a single user. |
339
339
  | `TriggerDescriptor` | type | `dist/core/connectors.d.ts:130-138` | Supporting types | A generated, typed connector-trigger descriptor: TriggerMeta branded with phantom `where`/output types. |
340
340
  | `TriggerMeta` | interface | `dist/core/connectors.d.ts:120-129` | Supporting types | Runtime metadata a generated trigger descriptor carries. |
341
- | `TriggerOptions` | interface | `dist/core/actions.d.ts:2845-2892` | Option shapes | The typed `onEvent`/`waitForEvent` options — everything an EventSubscription carries except `connector`/`event`, which… |
341
+ | `TriggerOptions` | interface | `dist/core/actions.d.ts:2719-2766` | Option shapes | The typed `onEvent`/`waitForEvent` options — everything an EventSubscription carries except `connector`/`event`, which… |
342
342
  | `TypeDesc` | type | `dist/core/expr.d.ts:385` | Supporting types | |
343
343
  | `UnresolvedReferenceTaskKind` | type | `dist/case/case-sdk.d.ts:358-359` | Supporting types | Published-resource task kinds that the Case schema permits as unresolved skeletons. |
344
344
  | `WaitConnectorPlaceholderSpec` | interface | `dist/case/case-sdk.d.ts:360-370` | Supporting types | A `wait-for-connector` subscription: suspend on an Integration Service event. |
@@ -389,7 +389,7 @@ could hand you spans for a version you do not have.
389
389
  | `errorSchema` | const | `dist/bpmn/bpmn-sdk.d.ts:3490-3531` | BPMN authoring | The `Error` variable's shape — the platform's own error envelope. |
390
390
  | `errorSchemaWithResponse` | const | `dist/bpmn/bpmn-sdk.d.ts:3532-3564` | BPMN authoring | The same envelope plus `response` — what a node whose failure carries a payload writes, and what the same source calls… |
391
391
  | `EventDef` | type | `dist/bpmn/bpmn-sdk.d.ts:54-72` | Supporting types | The resolved event definition attached to an event node. |
392
- | `EventFilter` | type | `dist/core/actions.d.ts:2803-2844` | Supporting types | One filter condition on the event payload. |
392
+ | `EventFilter` | type | `dist/core/actions.d.ts:2677-2718` | Supporting types | One filter condition on the event payload. |
393
393
  | `EventKind` | type | `dist/bpmn/bpmn-sdk.d.ts:75-76` | Supporting types | The four non-boundary event element kinds a BpmnNode can be. |
394
394
  | `EventSubProcessOpts` | interface | `dist/bpmn/bpmn-sdk.d.ts:1835-1895` | Option shapes | Options for ScopeBuilder.eventSubProcess. |
395
395
  | `ExtensionPayload` | interface | `dist/bpmn/bpmn-sdk.d.ts:557-593` | Supporting types | An extension payload carried by an element the payload does not describe. |