@uipath/maestro-builder-sdk 6.34.0 → 6.35.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.
Files changed (13) hide show
  1. package/dist/api-index.md +77 -73
  2. package/dist/api-members.md +266 -251
  3. package/dist/check.js +6 -2
  4. package/dist/core/actions.d.ts +103 -18
  5. package/dist/core/form-field-type.d.ts +77 -29
  6. package/dist/core/form-field-type.js +264 -46
  7. package/dist/decompile.js +57 -18
  8. package/dist/flow-node-type.d.ts +6 -0
  9. package/dist/merge.js +18 -6
  10. package/dist/nodes/hitl/flow/check.js +8 -4
  11. package/dist/nodes/hitl/flow/node-type.js +20 -20
  12. package/dist/serialize.js +7 -4
  13. package/package.json +2 -2
package/dist/api-index.md CHANGED
@@ -37,62 +37,62 @@ could hand you spans for a version you do not have.
37
37
 
38
38
  ## `@uipath/maestro-builder-sdk`
39
39
 
40
- 224 symbol(s). Import from `@uipath/maestro-builder-sdk`.
40
+ 228 symbol(s). Import from `@uipath/maestro-builder-sdk`.
41
41
 
42
42
  | Symbol | Kind | Declaration | Area | Summary |
43
43
  | --- | --- | --- | --- | --- |
44
- | `ActionSpec` | type | `dist/core/actions.d.ts:1620-1628` | 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:1938-1992` | Actions | Invoke an AGENT resource — either one published to Orchestrator or a sibling agent project registered in the same… |
46
- | `AgentFlavour` | type | `dist/core/actions.d.ts:633-637` | Supporting types | Which KIND of agent project was published behind a `uipath.core.agent.<key>` resource. |
47
- | `AgentGuardrail` | type | `dist/core/actions.d.ts:861` | Supporting types | |
48
- | `agenticProcess` | function | `dist/core/actions.d.ts:1892-1937` | Actions | Invoke a deployed AGENTIC PROCESS — a Maestro process orchestration published to Orchestrator: a BPMN process that… |
49
- | `AgenticProcessCompletion` | type | `dist/core/actions.d.ts:592-630` | Supporting types | Whether an Agentic Process step waits for the process's result. |
50
- | `AgenticProcessInputs` | type | `dist/core/actions.d.ts:631-632` | Option shapes | What `agenticProcess()` takes: the shared fields plus the completion policy. |
51
- | `AgenticProcessInputsBase` | interface | `dist/core/actions.d.ts:535-591` | Option shapes | 7 field(s) |
52
- | `AgentInputs` | interface | `dist/core/actions.d.ts:639-733` | Option shapes | 8 field(s) |
53
- | `AgentLocation` | type | `dist/core/actions.d.ts:638` | Supporting types | |
54
- | `AgentMemoryRef` | interface | `dist/core/actions.d.ts:1267-1291` | Supporting types | An episodic memory the agent learns from across runs, wired to the agent's own `memory` handle. |
55
- | `AgentResourcePlacement` | interface | `dist/core/actions.d.ts:1135-1170` | Supporting types | Where one of an inline agent's resources (a context index, a tool, an escalation) sits in the `.flow`: the id of its own… |
44
+ | `ActionSpec` | type | `dist/core/actions.d.ts:1705-1713` | 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:2023-2077` | Actions | Invoke an AGENT resource — either one published to Orchestrator or a sibling agent project registered in the same… |
46
+ | `AgentFlavour` | type | `dist/core/actions.d.ts:718-722` | Supporting types | Which KIND of agent project was published behind a `uipath.core.agent.<key>` resource. |
47
+ | `AgentGuardrail` | type | `dist/core/actions.d.ts:946` | Supporting types | |
48
+ | `agenticProcess` | function | `dist/core/actions.d.ts:1977-2022` | Actions | Invoke a deployed AGENTIC PROCESS — a Maestro process orchestration published to Orchestrator: a BPMN process that… |
49
+ | `AgenticProcessCompletion` | type | `dist/core/actions.d.ts:677-715` | Supporting types | Whether an Agentic Process step waits for the process's result. |
50
+ | `AgenticProcessInputs` | type | `dist/core/actions.d.ts:716-717` | Option shapes | What `agenticProcess()` takes: the shared fields plus the completion policy. |
51
+ | `AgenticProcessInputsBase` | interface | `dist/core/actions.d.ts:620-676` | Option shapes | 7 field(s) |
52
+ | `AgentInputs` | interface | `dist/core/actions.d.ts:724-818` | Option shapes | 8 field(s) |
53
+ | `AgentLocation` | type | `dist/core/actions.d.ts:723` | Supporting types | |
54
+ | `AgentMemoryRef` | interface | `dist/core/actions.d.ts:1352-1376` | Supporting types | An episodic memory the agent learns from across runs, wired to the agent's own `memory` handle. |
55
+ | `AgentResourcePlacement` | interface | `dist/core/actions.d.ts:1220-1255` | Supporting types | Where one of an inline agent's resources (a context index, a tool, an escalation) sits in the `.flow`: the id of its own… |
56
56
  | `Aggregation` | interface | `dist/nodes/transform/flow/spec.d.ts:36-42` | Supporting types | 3 field(s) |
57
57
  | `AggregationOperation` | type | `dist/nodes/transform/flow/spec.d.ts:35` | Supporting types | |
58
- | `apiWorkflow` | function | `dist/core/actions.d.ts:1757-1791` | Actions | Invoke a deployed API workflow — a coded workflow published to Orchestrator, run as a serverless job rather than by a… |
59
- | `ApiWorkflowInputs` | interface | `dist/core/actions.d.ts:468-499` | Option shapes | 5 field(s) |
58
+ | `apiWorkflow` | function | `dist/core/actions.d.ts:1842-1876` | Actions | Invoke a deployed API workflow — a coded workflow published to Orchestrator, run as a serverless job rather than by a… |
59
+ | `ApiWorkflowInputs` | interface | `dist/core/actions.d.ts:553-584` | Option shapes | 5 field(s) |
60
60
  | `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. |
61
61
  | `ArmBuilder` | class | `dist/flow-sdk.d.ts:1269-1292` | Builders | The sub-builder an ARM callback receives — a `StepList` that can also name itself with `.label(...)`. |
62
- | `AskedField` | interface | `dist/core/actions.d.ts:126-141` | Supporting types | A value the reviewer FILLS IN: read downstream with `out('<step>', '<id>')`. |
62
+ | `AskedField` | interface | `dist/core/actions.d.ts:221-231` | Supporting types | A value the reviewer FILLS IN: read downstream with `out('<step>', '<id>')`. |
63
63
  | `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… |
64
64
  | `BatchTransformInputs` | interface | `dist/nodes/ai-patterns/flow/spec.d.ts:48-63` | Option shapes | 4 field(s) |
65
65
  | `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… |
66
66
  | `BuiltEntryPoint` | interface | `dist/flow-sdk.d.ts:733-745` | Supporting types | One additional flow root, built by `.entryPoint()`. |
67
67
  | `BuiltFlow` | interface | `dist/flow-sdk.d.ts:746-793` | Supporting types | 17 field(s) |
68
- | `BuiltinToolName` | type | `dist/core/actions.d.ts:1123-1124` | Supporting types | The three platform-shipped built-in tools (fixed registry types). |
69
- | `BuiltinToolRef` | interface | `dist/core/actions.d.ts:1292-1312` | Supporting types | A platform built-in tool. |
70
- | `BuiltInValidatorGuardrail` | interface | `dist/core/actions.d.ts:819-860` | Supporting types | A platform-shipped validator, configured by parameters. |
68
+ | `BuiltinToolName` | type | `dist/core/actions.d.ts:1208-1209` | Supporting types | The three platform-shipped built-in tools (fixed registry types). |
69
+ | `BuiltinToolRef` | interface | `dist/core/actions.d.ts:1377-1397` | Supporting types | A platform built-in tool. |
70
+ | `BuiltInValidatorGuardrail` | interface | `dist/core/actions.d.ts:904-945` | Supporting types | A platform-shipped validator, configured by parameters. |
71
71
  | `CanonicalFormFieldType` | type | `dist/core/actions.d.ts:57-63` | Supporting types | The platform's 11 canonical quick-form field types (`@uipath/hitl-schema-types` `fieldType`), which the designer saves. |
72
72
  | `CaseValue` | type | `dist/flow-sdk.d.ts:339-340` | Supporting types | A value a `.switch` case compares the discriminant against. |
73
73
  | `ChildFlow` | type | `dist/flow-sdk.d.ts:55-58` | Supporting types | Anything `subflow()` accepts as the child: a builder, or an already-built flow. |
74
- | `ClientSideToolRef` | interface | `dist/core/actions.d.ts:1221-1236` | Supporting types | A CLIENT-side tool: the agent asks the CALLING application to run it and hand the answer back… |
75
- | `connector` | function | `dist/core/actions.d.ts:2044-2067` | Actions | Declare an Integration Service connector action — the typed form, where a generated descriptor supplies the nodeType and… |
76
- | `connector` | function | `dist/core/actions.d.ts:2068-2084` | Actions | Stringly form, for a connector with no prepared module — `connector('uipath-salesforce-slack',… |
74
+ | `ClientSideToolRef` | interface | `dist/core/actions.d.ts:1306-1321` | Supporting types | A CLIENT-side tool: the agent asks the CALLING application to run it and hand the answer back… |
75
+ | `connector` | function | `dist/core/actions.d.ts:2129-2152` | Actions | Declare an Integration Service connector action — the typed form, where a generated descriptor supplies the nodeType and… |
76
+ | `connector` | function | `dist/core/actions.d.ts:2153-2169` | Actions | Stringly form, for a connector with no prepared module — `connector('uipath-salesforce-slack',… |
77
77
  | `ConnectorDescriptor` | type | `dist/core/connectors.d.ts:89-97` | Generated descriptors | A generated, typed connector descriptor: ConnectorMeta branded with phantom input/output types. |
78
78
  | `ConnectorLookupValue` | type | `dist/core/connectors.d.ts:50-59` | Generated descriptors | ConnectorValue for a field that also accepts an unresolved lookup. |
79
79
  | `ConnectorMeta` | interface | `dist/core/connectors.d.ts:60-88` | Generated descriptors | Runtime metadata a generated descriptor carries. |
80
80
  | `ConnectorOpts` | interface | `dist/core/actions.d.ts:13-56` | Option shapes | 4 field(s) |
81
- | `ConnectorToolRef` | interface | `dist/core/actions.d.ts:1313-1350` | Supporting types | An Integration Service connector operation as a tool — e.g. "create a Jira issue". |
81
+ | `ConnectorToolRef` | interface | `dist/core/actions.d.ts:1398-1435` | Supporting types | An Integration Service connector operation as a tool — e.g. "create a Jira issue". |
82
82
  | `ConnectorValue` | type | `dist/core/connectors.d.ts:26-49` | Generated descriptors | What a generated `Inputs` property accepts: the value, or an expression. |
83
- | `ContextIndexRef` | interface | `dist/core/actions.d.ts:1501-1541` | Supporting types | One Context Grounding index an inline agent is grounded on, placed in the flow by AgentResourcePlacement. |
83
+ | `ContextIndexRef` | interface | `dist/core/actions.d.ts:1586-1626` | Supporting types | One Context Grounding index an inline agent is grounded on, placed in the flow by AgentResourcePlacement. |
84
84
  | `ContributionContext` | interface | `dist/core/node-classes.d.ts:68-79` | Supporting types | What the serializer tells a contributor before asking for its contribution. |
85
85
  | `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. |
86
86
  | `ControlFormFieldType` | type | `dist/core/actions.d.ts:64-72` | Supporting types | The platform's choice-control spellings of a field type. |
87
- | `conversationalAgent` | function | `dist/core/actions.d.ts:1867-1891` | Actions | A CONVERSATIONAL agent (`uipath.agent.conversational`) — it answers one turn of a live chat, reading the transcript… |
88
- | `ConversationalAgentInputs` | interface | `dist/core/actions.d.ts:190-236` | Option shapes | 10 field(s) |
89
- | `ConversationalAgentSettings` | interface | `dist/core/actions.d.ts:166-189` | Supporting types | How a conversational agent gets its turn — the node's own `conversationalAgentSettings` sub-object. |
87
+ | `conversationalAgent` | function | `dist/core/actions.d.ts:1952-1976` | Actions | A CONVERSATIONAL agent (`uipath.agent.conversational`) — it answers one turn of a live chat, reading the transcript… |
88
+ | `ConversationalAgentInputs` | interface | `dist/core/actions.d.ts:275-321` | Option shapes | 10 field(s) |
89
+ | `ConversationalAgentSettings` | interface | `dist/core/actions.d.ts:251-274` | Supporting types | How a conversational agent gets its turn — the node's own `conversationalAgentSettings` sub-object. |
90
90
  | `conversationContext` | function | `dist/nodes/conversation/flow/factories.d.ts:44-58` | Actions | READ a conversation's transcript so far without waiting (`uipath.conversational.get-conversation-context`) — the shape a… |
91
91
  | `ConversationContextInputs` | interface | `dist/nodes/conversation/flow/spec.d.ts:37-44` | Option shapes | 2 field(s) |
92
92
  | `conversationTrigger` | function | `dist/flow-sdk.d.ts:287-313` | Flow construction | Start the flow when a new CONVERSATION is created (`core.trigger.conversation`) — the entry point for a chat-driven… |
93
- | `createOutgoingCall` | function | `dist/core/actions.d.ts:1817-1833` | Actions | Place an outgoing phone call (`uipath.conversational.voice.create-outgoing-call`) and get back the `callContext` every… |
94
- | `CreateOutgoingCallInputs` | interface | `dist/core/actions.d.ts:237-245` | Option shapes | 2 field(s) |
95
- | `CustomGuardrail` | interface | `dist/core/actions.d.ts:806-818` | Supporting types | A rule-based guardrail you author in place. |
93
+ | `createOutgoingCall` | function | `dist/core/actions.d.ts:1902-1918` | Actions | Place an outgoing phone call (`uipath.conversational.voice.create-outgoing-call`) and get back the `callContext` every… |
94
+ | `CreateOutgoingCallInputs` | interface | `dist/core/actions.d.ts:322-330` | Option shapes | 2 field(s) |
95
+ | `CustomGuardrail` | interface | `dist/core/actions.d.ts:891-903` | Supporting types | A rule-based guardrail you author in place. |
96
96
  | `dataFabricCreate` | function | `dist/nodes/data-fabric/flow/factories.d.ts:56-79` | Actions | Create an entity record in Data Fabric (`core.datafabric.create`). |
97
97
  | `DataFabricCreateInputs` | interface | `dist/nodes/data-fabric/flow/spec.d.ts:129-159` | Option shapes | 4 field(s) |
98
98
  | `dataFabricDelete` | function | `dist/nodes/data-fabric/flow/factories.d.ts:96-113` | Actions | Delete an entity record from Data Fabric (`core.datafabric.delete`). |
@@ -118,14 +118,14 @@ could hand you spans for a version you do not have.
118
118
  | `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… |
119
119
  | `DynamicExtractInputs` | interface | `dist/nodes/document/flow/spec.d.ts:19-53` | Option shapes | 5 field(s) |
120
120
  | `EdgeRoute` | interface | `dist/flow-sdk.d.ts:657-671` | Supporting types | One edge's route: user-dragged bends and/or the auto-router's waypoints. |
121
- | `endCall` | function | `dist/core/actions.d.ts:1834-1841` | Actions | Hang up (`uipath.conversational.voice.end-call`). |
122
- | `EndCallInputs` | interface | `dist/core/actions.d.ts:246-253` | Option shapes | 1 field(s) |
121
+ | `endCall` | function | `dist/core/actions.d.ts:1919-1926` | Actions | Hang up (`uipath.conversational.voice.end-call`). |
122
+ | `EndCallInputs` | interface | `dist/core/actions.d.ts:331-338` | Option shapes | 1 field(s) |
123
123
  | `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` —… |
124
124
  | `err` | function | `dist/core/expr.d.ts:153-246` | Expressions and types | Reference a FAILED step's error → `$vars.<step>.error[.<field>]`. |
125
125
  | `ErrorEnvelopeField` | type | `dist/core/expr.d.ts:142-152` | Supporting types | The fields a failure envelope carries. |
126
- | `EscalationRef` | interface | `dist/core/actions.d.ts:1434-1500` | Supporting types | One escalation an inline agent may raise — an Action Center app task a human completes (the `coded-action-app` variant,… |
127
- | `EventFilter` | type | `dist/core/actions.d.ts:2085-2126` | Supporting types | One filter condition on the event payload. |
128
- | `EventSubscription` | interface | `dist/core/actions.d.ts:2175-2216` | Option shapes | What a connector event subscribes to. |
126
+ | `EscalationRef` | interface | `dist/core/actions.d.ts:1519-1585` | Supporting types | One escalation an inline agent may raise — an Action Center app task a human completes (the `coded-action-app` variant,… |
127
+ | `EventFilter` | type | `dist/core/actions.d.ts:2170-2211` | Supporting types | One filter condition on the event payload. |
128
+ | `EventSubscription` | interface | `dist/core/actions.d.ts:2260-2301` | Option shapes | What a connector event subscribes to. |
129
129
  | `Expr` | class | `dist/core/expr.d.ts:11-21` | Supporting types | A Flow expression. |
130
130
  | `FieldMapping` | interface | `dist/nodes/transform/flow/spec.d.ts:27-34` | Supporting types | 3 field(s) |
131
131
  | `FilterCondition` | type | `dist/nodes/transform/flow/spec.d.ts:10-11` | Supporting types | Comparison a filter rule applies to a field. |
@@ -134,22 +134,26 @@ could hand you spans for a version you do not have.
134
134
  | `flow` | function | `dist/flow-sdk.d.ts:1657-1672` | Flow construction | Start building a flow with the given id. |
135
135
  | `FlowAction` | class | `dist/core/node-classes.d.ts:162-168` | Supporting types | A node placed as a step — pass an instance to `.step(name, …)`. |
136
136
  | `FlowActionSpec` | type | `dist/flow-sdk.d.ts:53-54` | Supporting types | What `.step()` accepts here: the shared actions plus this SDK's subflow. |
137
- | `FlowActionSpecs` | interface | `dist/core/actions.d.ts:1542-1619` | Supporting types | Every action kind, keyed by kind, to the body of its spec — the arm's fields other than `kind`. |
137
+ | `FlowActionSpecs` | interface | `dist/core/actions.d.ts:1627-1704` | Supporting types | Every action kind, keyed by kind, to the body of its spec — the arm's fields other than `kind`. |
138
138
  | `FlowBuilder` | class | `dist/flow-sdk.d.ts:1293-1656` | Builders | 15 member(s) |
139
139
  | `FlowLayout` | interface | `dist/flow-sdk.d.ts:719-732` | Supporting types | Designer layout for a flow, keyed by AUTHOR-level ids: node entries by step name (plus the trigger id and `end`), edge… |
140
140
  | `FlowNode` | class | `dist/core/node-classes.d.ts:126-161` | Supporting types | The abstract root of every definition-backed node the builder can place. |
141
141
  | `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. |
142
142
  | `FlowTrigger` | class | `dist/core/node-classes.d.ts:169-175` | Supporting types | A node that starts the flow — pass an instance to `.trigger(…)`. |
143
- | `FormField` | type | `dist/core/actions.d.ts:165` | Supporting types | |
143
+ | `FormField` | type | `dist/core/actions.d.ts:250` | Supporting types | |
144
+ | `FormFieldCondition` | interface | `dist/core/actions.d.ts:113-133` | Supporting types | One condition of a form-field rule (`@uipath/hitl-schema-types` `fieldConditionSchema`): `when` names the field it… |
145
+ | `FormFieldControlType` | type | `dist/core/actions.d.ts:105-112` | Supporting types | How a form field renders (`@uipath/hitl-schema-types` `controlType`). |
144
146
  | `FormFieldOption` | interface | `dist/core/actions.d.ts:92-104` | Supporting types | One choice of a picker field (`@uipath/hitl-schema-types` `optionShape`): `value` is what the answer holds, `label` what… |
147
+ | `FormFieldRule` | interface | `dist/core/actions.d.ts:134-161` | Supporting types | A form-field rule (`@uipath/hitl-schema-types` `fieldRuleSchema`): when its conditions hold, its `effects` apply to the… |
148
+ | `FormFieldSettings` | interface | `dist/core/actions.d.ts:162-204` | Supporting types | The form-field keys that say how a field looks and behaves, with the platform's own names and shapes… |
145
149
  | `FormFieldType` | type | `dist/core/actions.d.ts:73-91` | Supporting types | A form field's type: one of the platform's canonical types; `'text'` / `'date-time'`, the SDK's older spellings of… |
146
150
  | `formTrigger` | function | `dist/flow-sdk.d.ts:258-286` | Flow construction | Start the flow from a FORM a person fills in (`core.trigger.form`) — the platform renders one field per flow input and… |
147
- | `GuardrailAction` | type | `dist/core/actions.d.ts:795-805` | Supporting types | What happens when a guardrail trips. |
148
- | `GuardrailFieldReference` | interface | `dist/core/actions.d.ts:762-767` | Supporting types | A field the rule or filter action points at. |
149
- | `GuardrailFieldSelector` | type | `dist/core/actions.d.ts:768-774` | Supporting types | All fields, or a named few. |
150
- | `GuardrailRule` | type | `dist/core/actions.d.ts:775-794` | Supporting types | One condition of a custom guardrail. |
151
- | `GuardrailScope` | type | `dist/core/actions.d.ts:754-755` | Supporting types | Where a guardrail applies: the whole agent, its LLM calls, or its tools. |
152
- | `GuardrailSelector` | interface | `dist/core/actions.d.ts:756-761` | Supporting types | Which artifacts inside the scope the guardrail watches. |
151
+ | `GuardrailAction` | type | `dist/core/actions.d.ts:880-890` | Supporting types | What happens when a guardrail trips. |
152
+ | `GuardrailFieldReference` | interface | `dist/core/actions.d.ts:847-852` | Supporting types | A field the rule or filter action points at. |
153
+ | `GuardrailFieldSelector` | type | `dist/core/actions.d.ts:853-859` | Supporting types | All fields, or a named few. |
154
+ | `GuardrailRule` | type | `dist/core/actions.d.ts:860-879` | Supporting types | One condition of a custom guardrail. |
155
+ | `GuardrailScope` | type | `dist/core/actions.d.ts:839-840` | Supporting types | Where a guardrail applies: the whole agent, its LLM calls, or its tools. |
156
+ | `GuardrailSelector` | interface | `dist/core/actions.d.ts:841-846` | Supporting types | Which artifacts inside the scope the guardrail watches. |
153
157
  | `hitl` | function | `dist/nodes/hitl/flow/factories.d.ts:7-58` | 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… |
154
158
  | `HitlAssigneeType` | type | `dist/nodes/hitl/flow/spec.d.ts:16-23` | Supporting types | How the task is assigned, the platform's own vocabulary (canvas `HITL_ASSIGNEE_TYPE`): `'user'` a single user, `'group'`… |
155
159
  | `HitlChannel` | type | `dist/nodes/hitl/flow/spec.d.ts:10-15` | Supporting types | Where the task is delivered. |
@@ -161,16 +165,16 @@ could hand you spans for a version you do not have.
161
165
  | `HttpBranch` | interface | `dist/nodes/http/flow/spec.d.ts:8-23` | Supporting types | One conditional response branch on an HTTP node — a designer-visible side exit. |
162
166
  | `HttpInputs` | type | `dist/nodes/http/flow/spec.d.ts:125-142` | Option shapes | |
163
167
  | `HttpInputsBase` | interface | `dist/nodes/http/flow/spec.d.ts:24-124` | Option shapes | 11 field(s) |
164
- | `HttpRequestToolRef` | interface | `dist/core/actions.d.ts:1237-1266` | Supporting types | The built-in HTTP-request tool (`uipath.agent.resource.tool.builtin.httprequest`): the agent performs an HTTP call. |
165
- | `inlineAgent` | function | `dist/core/actions.d.ts:1993-2043` | Actions | Declare an INLINE AUTONOMOUS AGENT — an agent defined inside this flow's own project rather than published to… |
166
- | `InlineAgentFieldType` | type | `dist/core/actions.d.ts:734-735` | Supporting types | A JSON-schema-ish type for one field of an inline agent's input/output schema. |
167
- | `InlineAgentInputs` | interface | `dist/core/actions.d.ts:862-1122` | Option shapes | 16 field(s) |
168
- | `InOutField` | interface | `dist/core/actions.d.ts:142-164` | Supporting types | A value the reviewer READS **and can correct**: pre-filled from the flow, editable on the form, and the (possibly… |
168
+ | `HttpRequestToolRef` | interface | `dist/core/actions.d.ts:1322-1351` | Supporting types | The built-in HTTP-request tool (`uipath.agent.resource.tool.builtin.httprequest`): the agent performs an HTTP call. |
169
+ | `inlineAgent` | function | `dist/core/actions.d.ts:2078-2128` | Actions | Declare an INLINE AUTONOMOUS AGENT — an agent defined inside this flow's own project rather than published to… |
170
+ | `InlineAgentFieldType` | type | `dist/core/actions.d.ts:819-820` | Supporting types | A JSON-schema-ish type for one field of an inline agent's input/output schema. |
171
+ | `InlineAgentInputs` | interface | `dist/core/actions.d.ts:947-1207` | Option shapes | 16 field(s) |
172
+ | `InOutField` | interface | `dist/core/actions.d.ts:232-249` | Supporting types | A value the reviewer READS **and can correct**: pre-filled from the flow, editable on the form, and the (possibly… |
169
173
  | `input` | function | `dist/core/expr.d.ts:44-61` | Expressions and types | Reference a flow input by name → `$vars.<triggerId>.output.<name>`. |
170
174
  | `isLookupToken` | function | `dist/core/lookups.d.ts:53-54` | Generated descriptors | True when `v` is an unresolved LookupToken. |
171
- | `ixpExtract` | function | `dist/core/actions.d.ts:1657-1711` | Actions | Extract fields from a document with a published IxP project — the platform's **Extract** node (`uipath.ixp.*`, service… |
172
- | `IxpExtractInputs` | interface | `dist/core/actions.d.ts:328-402` | Option shapes | 9 field(s) |
173
- | `IxpToolRef` | interface | `dist/core/actions.d.ts:1395-1433` | Supporting types | A published IxP (Intelligent eXtraction Platform) project as a tool — the agent decides when to extract a document and… |
175
+ | `ixpExtract` | function | `dist/core/actions.d.ts:1742-1796` | Actions | Extract fields from a document with a published IxP project — the platform's **Extract** node (`uipath.ixp.*`, service… |
176
+ | `IxpExtractInputs` | interface | `dist/core/actions.d.ts:413-487` | Option shapes | 9 field(s) |
177
+ | `IxpToolRef` | interface | `dist/core/actions.d.ts:1480-1518` | Supporting types | A published IxP (Intelligent eXtraction Platform) project as a tool — the agent decides when to extract a document and… |
174
178
  | `js` | function | `dist/core/expr.d.ts:247-282` | Expressions and types | Build a raw JS *expression* (a condition or computation). |
175
179
  | `lit` | function | `dist/core/expr.d.ts:22-28` | Expressions and types | A constant value baked directly into a node input. |
176
180
  | `lookup` | function | `dist/core/lookups.d.ts:95-102` | Generated descriptors | Begin resolving a lookup field on a generated descriptor. |
@@ -187,7 +191,7 @@ could hand you spans for a version you do not have.
187
191
  | `LookupToken` | interface | `dist/core/lookups.d.ts:37-52` | Generated descriptors | An unresolved lookup: what `.byEmail(…)` returns. |
188
192
  | `LoopOptions` | interface | `dist/flow-sdk.d.ts:487-511` | Option shapes | Loop-specific options. |
189
193
  | `manual` | function | `dist/flow-sdk.d.ts:181-190` | Flow construction | The manual trigger, explicitly. |
190
- | `McpToolRef` | interface | `dist/core/actions.d.ts:1171-1199` | Supporting types | An MCP server the agent may call tools on. |
194
+ | `McpToolRef` | interface | `dist/core/actions.d.ts:1256-1284` | Supporting types | An MCP server the agent may call tools on. |
191
195
  | `mock` | function | `dist/nodes/mock/flow/factories.d.ts:6-45` | Actions | Declare a PLACEHOLDER step — "a real node goes here later". |
192
196
  | `NodeContribution` | interface | `dist/core/node-classes.d.ts:102-125` | Supporting types | One validated construct, returned by FlowNode.contribute. |
193
197
  | `NodeLayout` | interface | `dist/flow-sdk.d.ts:642-656` | Supporting types | One node's designer layout: canvas position, and optionally size and collapsed state. |
@@ -198,24 +202,24 @@ could hand you spans for a version you do not have.
198
202
  | `Outcome` | type | `dist/nodes/hitl/flow/spec.d.ts:94-113` | Supporting types | One completion button. |
199
203
  | `OutputColumn` | interface | `dist/nodes/ai-patterns/flow/spec.d.ts:41-47` | Supporting types | One column Batch Transform appends to the CSV. |
200
204
  | `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… |
201
- | `ProcessLocation` | type | `dist/core/actions.d.ts:403-408` | Supporting types | Where a process resource lives: deployed to an Orchestrator folder (`'published'`, the default) or a sibling project of… |
202
- | `ProcessToolKind` | type | `dist/core/actions.d.ts:1351-1364` | Supporting types | The tool kinds that wrap a DEPLOYED tenant resource. |
203
- | `ProcessToolRef` | interface | `dist/core/actions.d.ts:1365-1394` | Supporting types | A deployed tenant resource the agent may invoke. |
204
- | `publishedFunction` | function | `dist/core/actions.d.ts:1792-1816` | Actions | Invoke a published Orchestrator **Function** — a deployed unit of code run as one step (`uipath.core.function.<key>`,… |
205
- | `PublishedFunctionInputs` | interface | `dist/core/actions.d.ts:500-534` | Option shapes | A published Orchestrator **Function** — a small, single-purpose unit of code deployed as its own resource and invoked as… |
205
+ | `ProcessLocation` | type | `dist/core/actions.d.ts:488-493` | Supporting types | Where a process resource lives: deployed to an Orchestrator folder (`'published'`, the default) or a sibling project of… |
206
+ | `ProcessToolKind` | type | `dist/core/actions.d.ts:1436-1449` | Supporting types | The tool kinds that wrap a DEPLOYED tenant resource. |
207
+ | `ProcessToolRef` | interface | `dist/core/actions.d.ts:1450-1479` | Supporting types | A deployed tenant resource the agent may invoke. |
208
+ | `publishedFunction` | function | `dist/core/actions.d.ts:1877-1901` | Actions | Invoke a published Orchestrator **Function** — a deployed unit of code run as one step (`uipath.core.function.<key>`,… |
209
+ | `PublishedFunctionInputs` | interface | `dist/core/actions.d.ts:585-619` | Option shapes | A published Orchestrator **Function** — a small, single-purpose unit of code deployed as its own resource and invoked as… |
206
210
  | `queueItem` | function | `dist/nodes/queue/flow/factories.d.ts:4-49` | Actions | Declare an Orchestrator QUEUE ITEM step. |
207
211
  | `QueueItemInputs` | interface | `dist/nodes/queue/flow/spec.d.ts:11-84` | Option shapes | 10 field(s) |
208
212
  | `QueuePriority` | type | `dist/nodes/queue/flow/spec.d.ts:9-10` | Supporting types | The three priorities an Orchestrator queue item can carry. |
209
213
  | `ran` | function | `dist/core/expr.d.ts:95-141` | Expressions and types | Did this step run? |
210
214
  | `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… |
211
215
  | `RawReference` | type | `dist/core/lookups.d.ts:190-198` | Supporting types | |
212
- | `RemoteA2aToolRef` | interface | `dist/core/actions.d.ts:1200-1220` | Supporting types | A remote A2A (agent-to-agent) endpoint the agent may delegate to. |
216
+ | `RemoteA2aToolRef` | interface | `dist/core/actions.d.ts:1285-1305` | Supporting types | A remote A2A (agent-to-agent) endpoint the agent may delegate to. |
213
217
  | `resolvedValue` | function | `dist/core/lookups.d.ts:172-179` | Generated descriptors | The recorded id for a token, or `undefined`. |
214
218
  | `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… |
215
- | `ReturnFieldType` | type | `dist/core/actions.d.ts:736-753` | Supporting types | A JSON-schema-ish type for one field of a step's declared `returns`. |
219
+ | `ReturnFieldType` | type | `dist/core/actions.d.ts:821-838` | Supporting types | A JSON-schema-ish type for one field of a step's declared `returns`. |
216
220
  | `ReturnOptions` | interface | `dist/flow-sdk.d.ts:445-486` | Option shapes | `.return(...)`-specific options. |
217
- | `rpaWorkflow` | function | `dist/core/actions.d.ts:1712-1756` | Actions | Invoke a deployed RPA (robotic process automation) workflow — a classic UI-automation process, published to… |
218
- | `RpaWorkflowInputs` | interface | `dist/core/actions.d.ts:409-467` | Option shapes | 7 field(s) |
221
+ | `rpaWorkflow` | function | `dist/core/actions.d.ts:1797-1841` | Actions | Invoke a deployed RPA (robotic process automation) workflow — a classic UI-automation process, published to… |
222
+ | `RpaWorkflowInputs` | interface | `dist/core/actions.d.ts:494-552` | Option shapes | 7 field(s) |
219
223
  | `SCHEDULE_PRESETS` | const | `dist/flow-sdk.d.ts:128-135` | Flow construction | The eight intervals the designer offers in its Frequency dropdown. |
220
224
  | `scheduled` | function | `dist/flow-sdk.d.ts:238-257` | Flow construction | Start the flow on a recurring schedule instead of on demand. |
221
225
  | `ScheduledInputs` | interface | `dist/flow-sdk.d.ts:149-161` | Option shapes | 1 field(s) |
@@ -227,7 +231,7 @@ could hand you spans for a version you do not have.
227
231
  | `ScriptReturnType` | type | `dist/core/script-return.d.ts:31-41` | Supporting types | The vocabulary a script's output can be declared as. |
228
232
  | `sendMessage` | function | `dist/nodes/conversation/flow/factories.d.ts:8-26` | Actions | Post an assistant message into a live conversation (`uipath.conversational.send-message`). |
229
233
  | `SendMessageInputs` | interface | `dist/nodes/conversation/flow/spec.d.ts:8-27` | Option shapes | 4 field(s) |
230
- | `ShownField` | interface | `dist/core/actions.d.ts:105-125` | Supporting types | A value the reviewer READS: shown on the form, filled in from the flow. |
234
+ | `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. |
231
235
  | `Step` | type | `dist/flow-sdk.d.ts:522-641` | Supporting types | |
232
236
  | `StepList` | class | `dist/flow-sdk.d.ts:794-1268` | Builders | Collects a sequence of steps. |
233
237
  | `STICKY_NOTE_COLORS` | const | `dist/flow-sdk.d.ts:672-677` | Flow construction | The designer's sticky-note palette. |
@@ -240,7 +244,7 @@ could hand you spans for a version you do not have.
240
244
  | `SwitchArm` | interface | `dist/flow-sdk.d.ts:358-377` | Supporting types | One arm of a built `.switch` (the serializer's view: body already collected). |
241
245
  | `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… |
242
246
  | `tmpl` | function | `dist/core/expr.d.ts:283-293` | Expressions and types | Build a JS *string template* (for URLs, messages, etc.). |
243
- | `ToolRef` | type | `dist/core/actions.d.ts:1125-1134` | Supporting types | One tool on an inline agent — a discriminated union over the kinds the tenant's registry actually serves… |
247
+ | `ToolRef` | type | `dist/core/actions.d.ts:1210-1219` | Supporting types | One tool on an inline agent — a discriminated union over the kinds the tenant's registry actually serves… |
244
248
  | `transform` | function | `dist/nodes/transform/flow/factories.d.ts:7-52` | Actions | Declare a Transform action — a chain of declarative operations over a collection. |
245
249
  | `Transformation` | type | `dist/nodes/transform/flow/spec.d.ts:25-26` | Supporting types | What a map does to a field's value. |
246
250
  | `TransformInputs` | interface | `dist/nodes/transform/flow/spec.d.ts:84-108` | Option shapes | 3 field(s) |
@@ -249,7 +253,7 @@ could hand you spans for a version you do not have.
249
253
  | `triggerDescriptor` | function | `dist/core/connectors.d.ts:139-151` | Generated descriptors | Brand a trigger descriptor literal with its where/output types. |
250
254
  | `TriggerDescriptor` | type | `dist/core/connectors.d.ts:130-138` | Generated descriptors | A generated, typed connector-trigger descriptor: TriggerMeta branded with phantom `where`/output types. |
251
255
  | `TriggerMeta` | interface | `dist/core/connectors.d.ts:120-129` | Generated descriptors | Runtime metadata a generated trigger descriptor carries. |
252
- | `TriggerOptions` | interface | `dist/core/actions.d.ts:2127-2174` | Option shapes | The typed `onEvent`/`waitForEvent` options — everything an EventSubscription carries except `connector`/`event`, which… |
256
+ | `TriggerOptions` | interface | `dist/core/actions.d.ts:2212-2259` | Option shapes | The typed `onEvent`/`waitForEvent` options — everything an EventSubscription carries except `connector`/`event`, which… |
253
257
  | `TriggerSpec` | type | `dist/flow-sdk.d.ts:162-180` | Supporting types | What starts the flow. |
254
258
  | `TypeDesc` | type | `dist/core/expr.d.ts:385` | Supporting types | |
255
259
  | `types` | const | `dist/core/expr.d.ts:369-384` | Expressions and types | Variable type descriptors (map to Flow variable `type` values). |
@@ -257,12 +261,12 @@ could hand you spans for a version you do not have.
257
261
  | `v` | function | `dist/core/expr.d.ts:29-41` | Expressions and types | Reference a flow variable or output by name → `$vars.<name>`. |
258
262
  | `VarDecl` | interface | `dist/flow-sdk.d.ts:59-71` | Supporting types | 7 field(s) |
259
263
  | `VarSpec` | interface | `dist/flow-sdk.d.ts:72-127` | Supporting types | The rich spelling of a variable declaration: pass it instead of a bare `types.*` descriptor wherever `.input()` /… |
260
- | `voiceAgent` | function | `dist/core/actions.d.ts:1842-1866` | Actions | Put a VOICE agent on a live call (`uipath.agent.voice`) — it speaks and listens for one turn, then the flow continues. |
261
- | `VoiceAgentInputs` | interface | `dist/core/actions.d.ts:277-310` | Option shapes | 6 field(s) |
262
- | `VoiceSettings` | interface | `dist/core/actions.d.ts:254-276` | Supporting types | The audio settings a voice agent speaks with. |
264
+ | `voiceAgent` | function | `dist/core/actions.d.ts:1927-1951` | Actions | Put a VOICE agent on a live call (`uipath.agent.voice`) — it speaks and listens for one turn, then the flow continues. |
265
+ | `VoiceAgentInputs` | interface | `dist/core/actions.d.ts:362-395` | Option shapes | 6 field(s) |
266
+ | `VoiceSettings` | interface | `dist/core/actions.d.ts:339-361` | Supporting types | The audio settings a voice agent speaks with. |
263
267
  | `voiceTrigger` | function | `dist/flow-sdk.d.ts:314-338` | Flow construction | Start the flow when a phone call comes IN (`core.trigger.voice`). |
264
- | `waitForEvent` | function | `dist/core/actions.d.ts:2226-2261` | Actions | Wait mid-flow until a connector event fires, then continue with its payload — the typed form, where a generated trigger… |
265
- | `waitForEvent` | function | `dist/core/actions.d.ts:2262-2269` | Actions | Stringly form, for an event with no prepared module. |
268
+ | `waitForEvent` | function | `dist/core/actions.d.ts:2311-2346` | Actions | Wait mid-flow until a connector event fires, then continue with its payload — the typed form, where a generated trigger… |
269
+ | `waitForEvent` | function | `dist/core/actions.d.ts:2347-2354` | Actions | Stringly form, for an event with no prepared module. |
266
270
  | `waitForMessage` | function | `dist/nodes/conversation/flow/factories.d.ts:27-43` | Actions | PAUSE until the person sends their next message (`uipath.conversational.wait-for-message`) — a catch event, like… |
267
271
  | `WaitForMessageInputs` | interface | `dist/nodes/conversation/flow/spec.d.ts:28-36` | Option shapes | 2 field(s) |
268
272
 
@@ -308,8 +312,8 @@ could hand you spans for a version you do not have.
308
312
  | `EscalationOpts` | interface | `dist/case/case-sdk.d.ts:127-139` | Option shapes | 4 field(s) |
309
313
  | `EscalationRecipient` | interface | `dist/case/case-sdk.d.ts:119-126` | Supporting types | Who an escalation notifies. |
310
314
  | `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`). |
311
- | `EventFilter` | type | `dist/core/actions.d.ts:2085-2126` | Supporting types | One filter condition on the event payload. |
312
- | `EventSubscription` | interface | `dist/core/actions.d.ts:2175-2216` | Option shapes | What a connector event subscribes to. |
315
+ | `EventFilter` | type | `dist/core/actions.d.ts:2170-2211` | Supporting types | One filter condition on the event payload. |
316
+ | `EventSubscription` | interface | `dist/core/actions.d.ts:2260-2301` | Option shapes | What a connector event subscribes to. |
313
317
  | `eventTrigger` | function | `dist/case/case-sdk.d.ts:294-304` | Case authoring | An Integration Service **event** trigger — an external event (a new row, an email, a webhook) starts the case. |
314
318
  | `eventTrigger` | function | `dist/case/case-sdk.d.ts:305-311` | Case authoring | An Integration Service event trigger in placeholder or stringly-resolved form. |
315
319
  | `EventTriggerOpts` | interface | `dist/case/case-sdk.d.ts:241-281` | Option shapes | 5 field(s) |
@@ -345,7 +349,7 @@ could hand you spans for a version you do not have.
345
349
  | `toUser` | function | `dist/case/case-sdk.d.ts:150-157` | Case authoring | An escalation recipient that is a single user. |
346
350
  | `TriggerDescriptor` | type | `dist/core/connectors.d.ts:130-138` | Supporting types | A generated, typed connector-trigger descriptor: TriggerMeta branded with phantom `where`/output types. |
347
351
  | `TriggerMeta` | interface | `dist/core/connectors.d.ts:120-129` | Supporting types | Runtime metadata a generated trigger descriptor carries. |
348
- | `TriggerOptions` | interface | `dist/core/actions.d.ts:2127-2174` | Option shapes | The typed `onEvent`/`waitForEvent` options — everything an EventSubscription carries except `connector`/`event`, which… |
352
+ | `TriggerOptions` | interface | `dist/core/actions.d.ts:2212-2259` | Option shapes | The typed `onEvent`/`waitForEvent` options — everything an EventSubscription carries except `connector`/`event`, which… |
349
353
  | `TypeDesc` | type | `dist/core/expr.d.ts:385` | Supporting types | |
350
354
  | `UnresolvedReferenceTaskKind` | type | `dist/case/case-sdk.d.ts:376-377` | Supporting types | Published-resource task kinds that the Case schema permits as unresolved skeletons. |
351
355
  | `WaitConnectorPlaceholderSpec` | interface | `dist/case/case-sdk.d.ts:378-388` | Supporting types | A `wait-for-connector` subscription: suspend on an Integration Service event. |
@@ -396,7 +400,7 @@ could hand you spans for a version you do not have.
396
400
  | `errorSchema` | const | `dist/bpmn/bpmn-sdk.d.ts:3490-3531` | BPMN authoring | The `Error` variable's shape — the platform's own error envelope. |
397
401
  | `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… |
398
402
  | `EventDef` | type | `dist/bpmn/bpmn-sdk.d.ts:54-72` | Supporting types | The resolved event definition attached to an event node. |
399
- | `EventFilter` | type | `dist/core/actions.d.ts:2085-2126` | Supporting types | One filter condition on the event payload. |
403
+ | `EventFilter` | type | `dist/core/actions.d.ts:2170-2211` | Supporting types | One filter condition on the event payload. |
400
404
  | `EventKind` | type | `dist/bpmn/bpmn-sdk.d.ts:75-76` | Supporting types | The four non-boundary event element kinds a BpmnNode can be. |
401
405
  | `EventSubProcessOpts` | interface | `dist/bpmn/bpmn-sdk.d.ts:1835-1895` | Option shapes | Options for ScopeBuilder.eventSubProcess. |
402
406
  | `ExtensionPayload` | interface | `dist/bpmn/bpmn-sdk.d.ts:557-593` | Supporting types | An extension payload carried by an element the payload does not describe. |