@uipath/maestro-builder-sdk 6.31.8 → 6.31.9
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 +75 -73
- package/dist/api-members.md +251 -245
- package/dist/check.js +11 -1
- package/dist/core/actions.d.ts +50 -4
- package/dist/core/form-field-type.d.ts +80 -14
- package/dist/core/form-field-type.js +132 -28
- package/dist/decompile.js +7 -1
- package/dist/nodes/hitl/flow/check.js +7 -1
- package/dist/nodes/hitl/flow/node-type.js +13 -1
- package/dist/serialize.js +12 -7
- package/package.json +2 -2
package/dist/api-index.md
CHANGED
|
@@ -37,60 +37,61 @@ could hand you spans for a version you do not have.
|
|
|
37
37
|
|
|
38
38
|
## `@uipath/maestro-builder-sdk`
|
|
39
39
|
|
|
40
|
-
|
|
40
|
+
223 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:
|
|
45
|
-
| `agent` | function | `dist/core/actions.d.ts:
|
|
46
|
-
| `AgentFlavour` | type | `dist/core/actions.d.ts:
|
|
47
|
-
| `AgentGuardrail` | type | `dist/core/actions.d.ts:
|
|
48
|
-
| `agenticProcess` | function | `dist/core/actions.d.ts:
|
|
49
|
-
| `AgenticProcessCompletion` | type | `dist/core/actions.d.ts:
|
|
50
|
-
| `AgenticProcessInputs` | type | `dist/core/actions.d.ts:
|
|
51
|
-
| `AgenticProcessInputsBase` | interface | `dist/core/actions.d.ts:
|
|
52
|
-
| `AgentInputs` | interface | `dist/core/actions.d.ts:
|
|
53
|
-
| `AgentLocation` | type | `dist/core/actions.d.ts:
|
|
54
|
-
| `AgentMemoryRef` | interface | `dist/core/actions.d.ts:
|
|
44
|
+
| `ActionSpec` | type | `dist/core/actions.d.ts:1578-1586` | 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:1896-1950` | 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:1850-1895` | 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:1231-1255` | 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:
|
|
58
|
-
| `ApiWorkflowInputs` | interface | `dist/core/actions.d.ts:
|
|
57
|
+
| `apiWorkflow` | function | `dist/core/actions.d.ts:1715-1749` | Actions | Invoke a deployed API workflow — a coded workflow published to Orchestrator, run as a serverless job rather than by a… |
|
|
58
|
+
| `ApiWorkflowInputs` | interface | `dist/core/actions.d.ts:468-499` | Option shapes | 5 field(s) |
|
|
59
59
|
| `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. |
|
|
60
60
|
| `ArmBuilder` | class | `dist/flow-sdk.d.ts:1235-1258` | Builders | The sub-builder an ARM callback receives — a `StepList` that can also name itself with `.label(...)`. |
|
|
61
|
-
| `AskedField` | interface | `dist/core/actions.d.ts:
|
|
61
|
+
| `AskedField` | interface | `dist/core/actions.d.ts:126-141` | Supporting types | A value the reviewer FILLS IN: read downstream with `out('<step>', '<id>')`. |
|
|
62
62
|
| `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… |
|
|
63
63
|
| `BatchTransformInputs` | interface | `dist/nodes/ai-patterns/flow/spec.d.ts:48-63` | 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
65
|
| `BuiltEntryPoint` | interface | `dist/flow-sdk.d.ts:724-736` | Supporting types | One additional flow root, built by `.entryPoint()`. |
|
|
66
66
|
| `BuiltFlow` | interface | `dist/flow-sdk.d.ts:737-784` | Supporting types | 17 field(s) |
|
|
67
|
-
| `BuiltinToolName` | type | `dist/core/actions.d.ts:
|
|
68
|
-
| `BuiltinToolRef` | interface | `dist/core/actions.d.ts:
|
|
69
|
-
| `BuiltInValidatorGuardrail` | interface | `dist/core/actions.d.ts:
|
|
67
|
+
| `BuiltinToolName` | type | `dist/core/actions.d.ts:1123-1124` | Supporting types | The three platform-shipped built-in tools (fixed registry types). |
|
|
68
|
+
| `BuiltinToolRef` | interface | `dist/core/actions.d.ts:1256-1276` | Supporting types | A platform built-in tool. |
|
|
69
|
+
| `BuiltInValidatorGuardrail` | interface | `dist/core/actions.d.ts:819-860` | Supporting types | A platform-shipped validator, configured by parameters. |
|
|
70
70
|
| `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. |
|
|
71
71
|
| `CaseValue` | type | `dist/flow-sdk.d.ts:339-340` | Supporting types | A value a `.switch` case compares the discriminant against. |
|
|
72
72
|
| `ChildFlow` | type | `dist/flow-sdk.d.ts:55-58` | Supporting types | Anything `subflow()` accepts as the child: a builder, or an already-built flow. |
|
|
73
|
-
| `ClientSideToolRef` | interface | `dist/core/actions.d.ts:
|
|
74
|
-
| `connector` | function | `dist/core/actions.d.ts:
|
|
75
|
-
| `connector` | function | `dist/core/actions.d.ts:
|
|
73
|
+
| `ClientSideToolRef` | interface | `dist/core/actions.d.ts:1185-1200` | Supporting types | A CLIENT-side tool: the agent asks the CALLING application to run it and hand the answer back… |
|
|
74
|
+
| `connector` | function | `dist/core/actions.d.ts:2002-2025` | Actions | Declare an Integration Service connector action — the typed form, where a generated descriptor supplies the nodeType and… |
|
|
75
|
+
| `connector` | function | `dist/core/actions.d.ts:2026-2042` | Actions | Stringly form, for a connector with no prepared module — `connector('uipath-salesforce-slack',… |
|
|
76
76
|
| `ConnectorDescriptor` | type | `dist/core/connectors.d.ts:89-97` | Generated descriptors | A generated, typed connector descriptor: ConnectorMeta branded with phantom input/output types. |
|
|
77
77
|
| `ConnectorLookupValue` | type | `dist/core/connectors.d.ts:50-59` | Generated descriptors | ConnectorValue for a field that also accepts an unresolved lookup. |
|
|
78
78
|
| `ConnectorMeta` | interface | `dist/core/connectors.d.ts:60-88` | Generated descriptors | Runtime metadata a generated descriptor carries. |
|
|
79
79
|
| `ConnectorOpts` | interface | `dist/core/actions.d.ts:13-56` | Option shapes | 4 field(s) |
|
|
80
|
-
| `ConnectorToolRef` | interface | `dist/core/actions.d.ts:
|
|
80
|
+
| `ConnectorToolRef` | interface | `dist/core/actions.d.ts:1277-1314` | Supporting types | An Integration Service connector operation as a tool — e.g. "create a Jira issue". |
|
|
81
81
|
| `ConnectorValue` | type | `dist/core/connectors.d.ts:26-49` | Generated descriptors | What a generated `Inputs` property accepts: the value, or an expression. |
|
|
82
|
-
| `ContextIndexRef` | interface | `dist/core/actions.d.ts:
|
|
82
|
+
| `ContextIndexRef` | interface | `dist/core/actions.d.ts:1465-1499` | Supporting types | One Context Grounding index an inline agent is grounded on. |
|
|
83
83
|
| `ContributionContext` | interface | `dist/core/node-classes.d.ts:68-79` | Supporting types | What the serializer tells a contributor before asking for its contribution. |
|
|
84
84
|
| `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. |
|
|
85
|
-
| `
|
|
86
|
-
| `
|
|
87
|
-
| `
|
|
85
|
+
| `ControlFormFieldType` | type | `dist/core/actions.d.ts:64-72` | Supporting types | The platform's choice-control spellings of a field type. |
|
|
86
|
+
| `conversationalAgent` | function | `dist/core/actions.d.ts:1825-1849` | Actions | A CONVERSATIONAL agent (`uipath.agent.conversational`) — it answers one turn of a live chat, reading the transcript… |
|
|
87
|
+
| `ConversationalAgentInputs` | interface | `dist/core/actions.d.ts:190-236` | Option shapes | 10 field(s) |
|
|
88
|
+
| `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. |
|
|
88
89
|
| `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… |
|
|
89
90
|
| `ConversationContextInputs` | interface | `dist/nodes/conversation/flow/spec.d.ts:37-44` | Option shapes | 2 field(s) |
|
|
90
91
|
| `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… |
|
|
91
|
-
| `createOutgoingCall` | function | `dist/core/actions.d.ts:
|
|
92
|
-
| `CreateOutgoingCallInputs` | interface | `dist/core/actions.d.ts:
|
|
93
|
-
| `CustomGuardrail` | interface | `dist/core/actions.d.ts:
|
|
92
|
+
| `createOutgoingCall` | function | `dist/core/actions.d.ts:1775-1791` | Actions | Place an outgoing phone call (`uipath.conversational.voice.create-outgoing-call`) and get back the `callContext` every… |
|
|
93
|
+
| `CreateOutgoingCallInputs` | interface | `dist/core/actions.d.ts:237-245` | Option shapes | 2 field(s) |
|
|
94
|
+
| `CustomGuardrail` | interface | `dist/core/actions.d.ts:806-818` | Supporting types | A rule-based guardrail you author in place. |
|
|
94
95
|
| `dataFabricCreate` | function | `dist/nodes/data-fabric/flow/factories.d.ts:56-79` | Actions | Create an entity record in Data Fabric (`core.datafabric.create`). |
|
|
95
96
|
| `DataFabricCreateInputs` | interface | `dist/nodes/data-fabric/flow/spec.d.ts:129-159` | Option shapes | 4 field(s) |
|
|
96
97
|
| `dataFabricDelete` | function | `dist/nodes/data-fabric/flow/factories.d.ts:96-113` | Actions | Delete an entity record from Data Fabric (`core.datafabric.delete`). |
|
|
@@ -116,14 +117,14 @@ could hand you spans for a version you do not have.
|
|
|
116
117
|
| `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… |
|
|
117
118
|
| `DynamicExtractInputs` | interface | `dist/nodes/document/flow/spec.d.ts:19-53` | Option shapes | 5 field(s) |
|
|
118
119
|
| `EdgeRoute` | interface | `dist/flow-sdk.d.ts:648-662` | Supporting types | One edge's route: user-dragged bends and/or the auto-router's waypoints. |
|
|
119
|
-
| `endCall` | function | `dist/core/actions.d.ts:
|
|
120
|
-
| `EndCallInputs` | interface | `dist/core/actions.d.ts:
|
|
120
|
+
| `endCall` | function | `dist/core/actions.d.ts:1792-1799` | Actions | Hang up (`uipath.conversational.voice.end-call`). |
|
|
121
|
+
| `EndCallInputs` | interface | `dist/core/actions.d.ts:246-253` | Option shapes | 1 field(s) |
|
|
121
122
|
| `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` —… |
|
|
122
123
|
| `err` | function | `dist/core/expr.d.ts:153-246` | Expressions and types | Reference a FAILED step's error → `$vars.<step>.error[.<field>]`. |
|
|
123
124
|
| `ErrorEnvelopeField` | type | `dist/core/expr.d.ts:142-152` | Supporting types | The fields a failure envelope carries. |
|
|
124
|
-
| `EscalationRef` | interface | `dist/core/actions.d.ts:
|
|
125
|
-
| `EventFilter` | type | `dist/core/actions.d.ts:
|
|
126
|
-
| `EventSubscription` | interface | `dist/core/actions.d.ts:
|
|
125
|
+
| `EscalationRef` | interface | `dist/core/actions.d.ts:1398-1464` | Supporting types | One escalation an inline agent may raise — an Action Center app task a human completes (the `coded-action-app` variant,… |
|
|
126
|
+
| `EventFilter` | type | `dist/core/actions.d.ts:2043-2084` | Supporting types | One filter condition on the event payload. |
|
|
127
|
+
| `EventSubscription` | interface | `dist/core/actions.d.ts:2133-2174` | Option shapes | What a connector event subscribes to. |
|
|
127
128
|
| `Expr` | class | `dist/core/expr.d.ts:11-21` | Supporting types | A Flow expression. |
|
|
128
129
|
| `FieldMapping` | interface | `dist/nodes/transform/flow/spec.d.ts:27-34` | Supporting types | 3 field(s) |
|
|
129
130
|
| `FilterCondition` | type | `dist/nodes/transform/flow/spec.d.ts:10-11` | Supporting types | Comparison a filter rule applies to a field. |
|
|
@@ -132,21 +133,22 @@ could hand you spans for a version you do not have.
|
|
|
132
133
|
| `flow` | function | `dist/flow-sdk.d.ts:1623-1638` | Flow construction | Start building a flow with the given id. |
|
|
133
134
|
| `FlowAction` | class | `dist/core/node-classes.d.ts:162-168` | Supporting types | A node placed as a step — pass an instance to `.step(name, …)`. |
|
|
134
135
|
| `FlowActionSpec` | type | `dist/flow-sdk.d.ts:53-54` | Supporting types | What `.step()` accepts here: the shared actions plus this SDK's subflow. |
|
|
135
|
-
| `FlowActionSpecs` | interface | `dist/core/actions.d.ts:
|
|
136
|
+
| `FlowActionSpecs` | interface | `dist/core/actions.d.ts:1500-1577` | Supporting types | Every action kind, keyed by kind, to the body of its spec — the arm's fields other than `kind`. |
|
|
136
137
|
| `FlowBuilder` | class | `dist/flow-sdk.d.ts:1259-1622` | Builders | 15 member(s) |
|
|
137
138
|
| `FlowLayout` | interface | `dist/flow-sdk.d.ts:710-723` | Supporting types | Designer layout for a flow, keyed by AUTHOR-level ids: node entries by step name (plus the trigger id and `end`), edge… |
|
|
138
139
|
| `FlowNode` | class | `dist/core/node-classes.d.ts:126-161` | Supporting types | The abstract root of every definition-backed node the builder can place. |
|
|
139
140
|
| `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. |
|
|
140
141
|
| `FlowTrigger` | class | `dist/core/node-classes.d.ts:169-175` | Supporting types | A node that starts the flow — pass an instance to `.trigger(…)`. |
|
|
141
|
-
| `FormField` | type | `dist/core/actions.d.ts:
|
|
142
|
-
| `
|
|
142
|
+
| `FormField` | type | `dist/core/actions.d.ts:165` | Supporting types | |
|
|
143
|
+
| `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… |
|
|
144
|
+
| `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… |
|
|
143
145
|
| `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… |
|
|
144
|
-
| `GuardrailAction` | type | `dist/core/actions.d.ts:
|
|
145
|
-
| `GuardrailFieldReference` | interface | `dist/core/actions.d.ts:
|
|
146
|
-
| `GuardrailFieldSelector` | type | `dist/core/actions.d.ts:
|
|
147
|
-
| `GuardrailRule` | type | `dist/core/actions.d.ts:
|
|
148
|
-
| `GuardrailScope` | type | `dist/core/actions.d.ts:
|
|
149
|
-
| `GuardrailSelector` | interface | `dist/core/actions.d.ts:
|
|
146
|
+
| `GuardrailAction` | type | `dist/core/actions.d.ts:795-805` | Supporting types | What happens when a guardrail trips. |
|
|
147
|
+
| `GuardrailFieldReference` | interface | `dist/core/actions.d.ts:762-767` | Supporting types | A field the rule or filter action points at. |
|
|
148
|
+
| `GuardrailFieldSelector` | type | `dist/core/actions.d.ts:768-774` | Supporting types | All fields, or a named few. |
|
|
149
|
+
| `GuardrailRule` | type | `dist/core/actions.d.ts:775-794` | Supporting types | One condition of a custom guardrail. |
|
|
150
|
+
| `GuardrailScope` | type | `dist/core/actions.d.ts:754-755` | Supporting types | Where a guardrail applies: the whole agent, its LLM calls, or its tools. |
|
|
151
|
+
| `GuardrailSelector` | interface | `dist/core/actions.d.ts:756-761` | Supporting types | Which artifacts inside the scope the guardrail watches. |
|
|
150
152
|
| `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… |
|
|
151
153
|
| `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'`… |
|
|
152
154
|
| `HitlChannel` | type | `dist/nodes/hitl/flow/spec.d.ts:10-15` | Supporting types | Where the task is delivered. |
|
|
@@ -158,16 +160,16 @@ could hand you spans for a version you do not have.
|
|
|
158
160
|
| `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. |
|
|
159
161
|
| `HttpInputs` | type | `dist/nodes/http/flow/spec.d.ts:125-142` | Option shapes | |
|
|
160
162
|
| `HttpInputsBase` | interface | `dist/nodes/http/flow/spec.d.ts:24-124` | Option shapes | 11 field(s) |
|
|
161
|
-
| `HttpRequestToolRef` | interface | `dist/core/actions.d.ts:
|
|
162
|
-
| `inlineAgent` | function | `dist/core/actions.d.ts:
|
|
163
|
-
| `InlineAgentFieldType` | type | `dist/core/actions.d.ts:
|
|
164
|
-
| `InlineAgentInputs` | interface | `dist/core/actions.d.ts:
|
|
165
|
-
| `InOutField` | interface | `dist/core/actions.d.ts:
|
|
163
|
+
| `HttpRequestToolRef` | interface | `dist/core/actions.d.ts:1201-1230` | Supporting types | The built-in HTTP-request tool (`uipath.agent.resource.tool.builtin.httprequest`): the agent performs an HTTP call. |
|
|
164
|
+
| `inlineAgent` | function | `dist/core/actions.d.ts:1951-2001` | Actions | Declare an INLINE AUTONOMOUS AGENT — an agent defined inside this flow's own project rather than published to… |
|
|
165
|
+
| `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. |
|
|
166
|
+
| `InlineAgentInputs` | interface | `dist/core/actions.d.ts:862-1122` | Option shapes | 16 field(s) |
|
|
167
|
+
| `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… |
|
|
166
168
|
| `input` | function | `dist/core/expr.d.ts:44-61` | Expressions and types | Reference a flow input by name → `$vars.<triggerId>.output.<name>`. |
|
|
167
169
|
| `isLookupToken` | function | `dist/core/lookups.d.ts:53-54` | Generated descriptors | True when `v` is an unresolved LookupToken. |
|
|
168
|
-
| `ixpExtract` | function | `dist/core/actions.d.ts:
|
|
169
|
-
| `IxpExtractInputs` | interface | `dist/core/actions.d.ts:
|
|
170
|
-
| `IxpToolRef` | interface | `dist/core/actions.d.ts:
|
|
170
|
+
| `ixpExtract` | function | `dist/core/actions.d.ts:1615-1669` | Actions | Extract fields from a document with a published IxP project — the platform's **Extract** node (`uipath.ixp.*`, service… |
|
|
171
|
+
| `IxpExtractInputs` | interface | `dist/core/actions.d.ts:328-402` | Option shapes | 9 field(s) |
|
|
172
|
+
| `IxpToolRef` | interface | `dist/core/actions.d.ts:1359-1397` | Supporting types | A published IxP (Intelligent eXtraction Platform) project as a tool — the agent decides when to extract a document and… |
|
|
171
173
|
| `js` | function | `dist/core/expr.d.ts:247-282` | Expressions and types | Build a raw JS *expression* (a condition or computation). |
|
|
172
174
|
| `lit` | function | `dist/core/expr.d.ts:22-28` | Expressions and types | A constant value baked directly into a node input. |
|
|
173
175
|
| `lookup` | function | `dist/core/lookups.d.ts:95-102` | Generated descriptors | Begin resolving a lookup field on a generated descriptor. |
|
|
@@ -184,7 +186,7 @@ could hand you spans for a version you do not have.
|
|
|
184
186
|
| `LookupToken` | interface | `dist/core/lookups.d.ts:37-52` | Generated descriptors | An unresolved lookup: what `.byEmail(…)` returns. |
|
|
185
187
|
| `LoopOptions` | interface | `dist/flow-sdk.d.ts:478-502` | Option shapes | Loop-specific options. |
|
|
186
188
|
| `manual` | function | `dist/flow-sdk.d.ts:181-190` | Flow construction | The manual trigger, explicitly. |
|
|
187
|
-
| `McpToolRef` | interface | `dist/core/actions.d.ts:
|
|
189
|
+
| `McpToolRef` | interface | `dist/core/actions.d.ts:1135-1163` | Supporting types | An MCP server the agent may call tools on. |
|
|
188
190
|
| `mock` | function | `dist/nodes/mock/flow/factories.d.ts:6-45` | Actions | Declare a PLACEHOLDER step — "a real node goes here later". |
|
|
189
191
|
| `NodeContribution` | interface | `dist/core/node-classes.d.ts:102-125` | Supporting types | One validated construct, returned by FlowNode.contribute. |
|
|
190
192
|
| `NodeLayout` | interface | `dist/flow-sdk.d.ts:633-647` | Supporting types | One node's designer layout: canvas position, and optionally size and collapsed state. |
|
|
@@ -195,24 +197,24 @@ could hand you spans for a version you do not have.
|
|
|
195
197
|
| `Outcome` | type | `dist/nodes/hitl/flow/spec.d.ts:94-113` | Supporting types | One completion button. |
|
|
196
198
|
| `OutputColumn` | interface | `dist/nodes/ai-patterns/flow/spec.d.ts:41-47` | Supporting types | One column Batch Transform appends to the CSV. |
|
|
197
199
|
| `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… |
|
|
198
|
-
| `ProcessLocation` | type | `dist/core/actions.d.ts:
|
|
199
|
-
| `ProcessToolKind` | type | `dist/core/actions.d.ts:
|
|
200
|
-
| `ProcessToolRef` | interface | `dist/core/actions.d.ts:
|
|
201
|
-
| `publishedFunction` | function | `dist/core/actions.d.ts:
|
|
202
|
-
| `PublishedFunctionInputs` | interface | `dist/core/actions.d.ts:
|
|
200
|
+
| `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… |
|
|
201
|
+
| `ProcessToolKind` | type | `dist/core/actions.d.ts:1315-1328` | Supporting types | The tool kinds that wrap a DEPLOYED tenant resource. |
|
|
202
|
+
| `ProcessToolRef` | interface | `dist/core/actions.d.ts:1329-1358` | Supporting types | A deployed tenant resource the agent may invoke. |
|
|
203
|
+
| `publishedFunction` | function | `dist/core/actions.d.ts:1750-1774` | Actions | Invoke a published Orchestrator **Function** — a deployed unit of code run as one step (`uipath.core.function.<key>`,… |
|
|
204
|
+
| `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… |
|
|
203
205
|
| `queueItem` | function | `dist/nodes/queue/flow/factories.d.ts:4-49` | Actions | Declare an Orchestrator QUEUE ITEM step. |
|
|
204
206
|
| `QueueItemInputs` | interface | `dist/nodes/queue/flow/spec.d.ts:11-84` | Option shapes | 10 field(s) |
|
|
205
207
|
| `QueuePriority` | type | `dist/nodes/queue/flow/spec.d.ts:9-10` | Supporting types | The three priorities an Orchestrator queue item can carry. |
|
|
206
208
|
| `ran` | function | `dist/core/expr.d.ts:95-141` | Expressions and types | Did this step run? |
|
|
207
209
|
| `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… |
|
|
208
210
|
| `RawReference` | type | `dist/core/lookups.d.ts:190-198` | Supporting types | |
|
|
209
|
-
| `RemoteA2aToolRef` | interface | `dist/core/actions.d.ts:
|
|
211
|
+
| `RemoteA2aToolRef` | interface | `dist/core/actions.d.ts:1164-1184` | Supporting types | A remote A2A (agent-to-agent) endpoint the agent may delegate to. |
|
|
210
212
|
| `resolvedValue` | function | `dist/core/lookups.d.ts:172-179` | Generated descriptors | The recorded id for a token, or `undefined`. |
|
|
211
213
|
| `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… |
|
|
212
|
-
| `ReturnFieldType` | type | `dist/core/actions.d.ts:
|
|
214
|
+
| `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`. |
|
|
213
215
|
| `ReturnOptions` | interface | `dist/flow-sdk.d.ts:445-477` | Option shapes | `.return(...)`-specific options. |
|
|
214
|
-
| `rpaWorkflow` | function | `dist/core/actions.d.ts:
|
|
215
|
-
| `RpaWorkflowInputs` | interface | `dist/core/actions.d.ts:
|
|
216
|
+
| `rpaWorkflow` | function | `dist/core/actions.d.ts:1670-1714` | Actions | Invoke a deployed RPA (robotic process automation) workflow — a classic UI-automation process, published to… |
|
|
217
|
+
| `RpaWorkflowInputs` | interface | `dist/core/actions.d.ts:409-467` | Option shapes | 7 field(s) |
|
|
216
218
|
| `SCHEDULE_PRESETS` | const | `dist/flow-sdk.d.ts:128-135` | Flow construction | The eight intervals the designer offers in its Frequency dropdown. |
|
|
217
219
|
| `scheduled` | function | `dist/flow-sdk.d.ts:238-257` | Flow construction | Start the flow on a recurring schedule instead of on demand. |
|
|
218
220
|
| `ScheduledInputs` | interface | `dist/flow-sdk.d.ts:149-161` | Option shapes | 1 field(s) |
|
|
@@ -224,7 +226,7 @@ could hand you spans for a version you do not have.
|
|
|
224
226
|
| `ScriptReturnType` | type | `dist/core/script-return.d.ts:31-41` | Supporting types | The vocabulary a script's output can be declared as. |
|
|
225
227
|
| `sendMessage` | function | `dist/nodes/conversation/flow/factories.d.ts:8-26` | Actions | Post an assistant message into a live conversation (`uipath.conversational.send-message`). |
|
|
226
228
|
| `SendMessageInputs` | interface | `dist/nodes/conversation/flow/spec.d.ts:8-27` | Option shapes | 4 field(s) |
|
|
227
|
-
| `ShownField` | interface | `dist/core/actions.d.ts:
|
|
229
|
+
| `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. |
|
|
228
230
|
| `Step` | type | `dist/flow-sdk.d.ts:513-632` | Supporting types | |
|
|
229
231
|
| `StepList` | class | `dist/flow-sdk.d.ts:785-1234` | Builders | Collects a sequence of steps. |
|
|
230
232
|
| `STICKY_NOTE_COLORS` | const | `dist/flow-sdk.d.ts:663-668` | Flow construction | The designer's sticky-note palette. |
|
|
@@ -237,7 +239,7 @@ could hand you spans for a version you do not have.
|
|
|
237
239
|
| `SwitchArm` | interface | `dist/flow-sdk.d.ts:358-377` | Supporting types | One arm of a built `.switch` (the serializer's view: body already collected). |
|
|
238
240
|
| `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… |
|
|
239
241
|
| `tmpl` | function | `dist/core/expr.d.ts:283-293` | Expressions and types | Build a JS *string template* (for URLs, messages, etc.). |
|
|
240
|
-
| `ToolRef` | type | `dist/core/actions.d.ts:
|
|
242
|
+
| `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… |
|
|
241
243
|
| `transform` | function | `dist/nodes/transform/flow/factories.d.ts:7-52` | Actions | Declare a Transform action — a chain of declarative operations over a collection. |
|
|
242
244
|
| `Transformation` | type | `dist/nodes/transform/flow/spec.d.ts:25-26` | Supporting types | What a map does to a field's value. |
|
|
243
245
|
| `TransformInputs` | interface | `dist/nodes/transform/flow/spec.d.ts:84-108` | Option shapes | 3 field(s) |
|
|
@@ -246,7 +248,7 @@ could hand you spans for a version you do not have.
|
|
|
246
248
|
| `triggerDescriptor` | function | `dist/core/connectors.d.ts:139-151` | Generated descriptors | Brand a trigger descriptor literal with its where/output types. |
|
|
247
249
|
| `TriggerDescriptor` | type | `dist/core/connectors.d.ts:130-138` | Generated descriptors | A generated, typed connector-trigger descriptor: TriggerMeta branded with phantom `where`/output types. |
|
|
248
250
|
| `TriggerMeta` | interface | `dist/core/connectors.d.ts:120-129` | Generated descriptors | Runtime metadata a generated trigger descriptor carries. |
|
|
249
|
-
| `TriggerOptions` | interface | `dist/core/actions.d.ts:
|
|
251
|
+
| `TriggerOptions` | interface | `dist/core/actions.d.ts:2085-2132` | Option shapes | The typed `onEvent`/`waitForEvent` options — everything an EventSubscription carries except `connector`/`event`, which… |
|
|
250
252
|
| `TriggerSpec` | type | `dist/flow-sdk.d.ts:162-180` | Supporting types | What starts the flow. |
|
|
251
253
|
| `TypeDesc` | type | `dist/core/expr.d.ts:385` | Supporting types | |
|
|
252
254
|
| `types` | const | `dist/core/expr.d.ts:369-384` | Expressions and types | Variable type descriptors (map to Flow variable `type` values). |
|
|
@@ -254,12 +256,12 @@ could hand you spans for a version you do not have.
|
|
|
254
256
|
| `v` | function | `dist/core/expr.d.ts:29-41` | Expressions and types | Reference a flow variable or output by name → `$vars.<name>`. |
|
|
255
257
|
| `VarDecl` | interface | `dist/flow-sdk.d.ts:59-71` | Supporting types | 7 field(s) |
|
|
256
258
|
| `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()` /… |
|
|
257
|
-
| `voiceAgent` | function | `dist/core/actions.d.ts:
|
|
258
|
-
| `VoiceAgentInputs` | interface | `dist/core/actions.d.ts:
|
|
259
|
-
| `VoiceSettings` | interface | `dist/core/actions.d.ts:
|
|
259
|
+
| `voiceAgent` | function | `dist/core/actions.d.ts:1800-1824` | Actions | Put a VOICE agent on a live call (`uipath.agent.voice`) — it speaks and listens for one turn, then the flow continues. |
|
|
260
|
+
| `VoiceAgentInputs` | interface | `dist/core/actions.d.ts:277-310` | Option shapes | 6 field(s) |
|
|
261
|
+
| `VoiceSettings` | interface | `dist/core/actions.d.ts:254-276` | Supporting types | The audio settings a voice agent speaks with. |
|
|
260
262
|
| `voiceTrigger` | function | `dist/flow-sdk.d.ts:314-338` | Flow construction | Start the flow when a phone call comes IN (`core.trigger.voice`). |
|
|
261
|
-
| `waitForEvent` | function | `dist/core/actions.d.ts:
|
|
262
|
-
| `waitForEvent` | function | `dist/core/actions.d.ts:
|
|
263
|
+
| `waitForEvent` | function | `dist/core/actions.d.ts:2184-2219` | Actions | Wait mid-flow until a connector event fires, then continue with its payload — the typed form, where a generated trigger… |
|
|
264
|
+
| `waitForEvent` | function | `dist/core/actions.d.ts:2220-2227` | Actions | Stringly form, for an event with no prepared module. |
|
|
263
265
|
| `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… |
|
|
264
266
|
| `WaitForMessageInputs` | interface | `dist/nodes/conversation/flow/spec.d.ts:28-36` | Option shapes | 2 field(s) |
|
|
265
267
|
|
|
@@ -303,8 +305,8 @@ could hand you spans for a version you do not have.
|
|
|
303
305
|
| `EscalationOpts` | interface | `dist/case/case-sdk.d.ts:127-139` | Option shapes | 4 field(s) |
|
|
304
306
|
| `EscalationRecipient` | interface | `dist/case/case-sdk.d.ts:119-126` | Supporting types | Who an escalation notifies. |
|
|
305
307
|
| `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`). |
|
|
306
|
-
| `EventFilter` | type | `dist/core/actions.d.ts:
|
|
307
|
-
| `EventSubscription` | interface | `dist/core/actions.d.ts:
|
|
308
|
+
| `EventFilter` | type | `dist/core/actions.d.ts:2043-2084` | Supporting types | One filter condition on the event payload. |
|
|
309
|
+
| `EventSubscription` | interface | `dist/core/actions.d.ts:2133-2174` | Option shapes | What a connector event subscribes to. |
|
|
308
310
|
| `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. |
|
|
309
311
|
| `eventTrigger` | function | `dist/case/case-sdk.d.ts:287-293` | Case authoring | An Integration Service event trigger in placeholder or stringly-resolved form. |
|
|
310
312
|
| `EventTriggerOpts` | interface | `dist/case/case-sdk.d.ts:239-263` | Option shapes | 4 field(s) |
|
|
@@ -340,7 +342,7 @@ could hand you spans for a version you do not have.
|
|
|
340
342
|
| `toUser` | function | `dist/case/case-sdk.d.ts:150-157` | Case authoring | An escalation recipient that is a single user. |
|
|
341
343
|
| `TriggerDescriptor` | type | `dist/core/connectors.d.ts:130-138` | Supporting types | A generated, typed connector-trigger descriptor: TriggerMeta branded with phantom `where`/output types. |
|
|
342
344
|
| `TriggerMeta` | interface | `dist/core/connectors.d.ts:120-129` | Supporting types | Runtime metadata a generated trigger descriptor carries. |
|
|
343
|
-
| `TriggerOptions` | interface | `dist/core/actions.d.ts:
|
|
345
|
+
| `TriggerOptions` | interface | `dist/core/actions.d.ts:2085-2132` | Option shapes | The typed `onEvent`/`waitForEvent` options — everything an EventSubscription carries except `connector`/`event`, which… |
|
|
344
346
|
| `TypeDesc` | type | `dist/core/expr.d.ts:385` | Supporting types | |
|
|
345
347
|
| `UnresolvedReferenceTaskKind` | type | `dist/case/case-sdk.d.ts:358-359` | Supporting types | Published-resource task kinds that the Case schema permits as unresolved skeletons. |
|
|
346
348
|
| `WaitConnectorPlaceholderSpec` | interface | `dist/case/case-sdk.d.ts:360-370` | Supporting types | A `wait-for-connector` subscription: suspend on an Integration Service event. |
|
|
@@ -391,7 +393,7 @@ could hand you spans for a version you do not have.
|
|
|
391
393
|
| `errorSchema` | const | `dist/bpmn/bpmn-sdk.d.ts:3490-3531` | BPMN authoring | The `Error` variable's shape — the platform's own error envelope. |
|
|
392
394
|
| `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… |
|
|
393
395
|
| `EventDef` | type | `dist/bpmn/bpmn-sdk.d.ts:54-72` | Supporting types | The resolved event definition attached to an event node. |
|
|
394
|
-
| `EventFilter` | type | `dist/core/actions.d.ts:
|
|
396
|
+
| `EventFilter` | type | `dist/core/actions.d.ts:2043-2084` | Supporting types | One filter condition on the event payload. |
|
|
395
397
|
| `EventKind` | type | `dist/bpmn/bpmn-sdk.d.ts:75-76` | Supporting types | The four non-boundary event element kinds a BpmnNode can be. |
|
|
396
398
|
| `EventSubProcessOpts` | interface | `dist/bpmn/bpmn-sdk.d.ts:1835-1895` | Option shapes | Options for ScopeBuilder.eventSubProcess. |
|
|
397
399
|
| `ExtensionPayload` | interface | `dist/bpmn/bpmn-sdk.d.ts:557-593` | Supporting types | An extension payload carried by an element the payload does not describe. |
|