@uipath/maestro-builder-sdk 6.43.0 → 6.44.0
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 +66 -65
- package/dist/api-members.md +228 -226
- package/dist/check.js +101 -7
- package/dist/core/actions.d.ts +9 -0
- package/dist/core/form-field-type.d.ts +7 -0
- package/dist/core/form-field-type.js +12 -2
- package/dist/decompile.js +204 -34
- package/dist/flow-expr-check.js +5 -0
- package/dist/flow-node-type.d.ts +9 -0
- package/dist/flow-sdk.d.ts +40 -5
- package/dist/flow-sdk.js +14 -1
- package/dist/flow-step-variables.d.ts +4 -0
- package/dist/flow-step-variables.js +22 -0
- package/dist/loop-version.d.ts +23 -6
- package/dist/loop-version.js +37 -15
- package/dist/nodes/hitl/flow/check.js +15 -0
- package/dist/nodes/hitl/flow/node-type.js +18 -3
- package/dist/nodes/process/flow/node-type.js +17 -2
- package/dist/serialize.js +56 -15
- package/package.json +2 -2
package/dist/api-index.md
CHANGED
|
@@ -37,51 +37,51 @@ could hand you spans for a version you do not have.
|
|
|
37
37
|
|
|
38
38
|
## `@uipath/maestro-builder-sdk`
|
|
39
39
|
|
|
40
|
-
|
|
40
|
+
232 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:
|
|
44
|
+
| `ActionSpec` | type | `dist/core/actions.d.ts:943-951` | Supporting types | One action step's spec: `{ kind }` plus that kind's body from FlowActionSpecs, for every kind there. |
|
|
45
45
|
| `agent` | function | `dist/nodes/process/flow/factories.d.ts:159-213` | Actions | Invoke an AGENT resource — either one published to Orchestrator or a sibling agent project registered in the same… |
|
|
46
46
|
| `AgentFlavour` | type | `dist/nodes/process/flow/spec.d.ts:235-239` | Supporting types | Which KIND of agent project was published behind a `uipath.core.agent.<key>` resource. |
|
|
47
|
-
| `AgentGuardrail` | type | `dist/core/actions.d.ts:
|
|
47
|
+
| `AgentGuardrail` | type | `dist/core/actions.d.ts:485` | Supporting types | |
|
|
48
48
|
| `agenticProcess` | function | `dist/nodes/process/flow/factories.d.ts:113-158` | Actions | Invoke a deployed AGENTIC PROCESS — a Maestro process orchestration published to Orchestrator: a BPMN process that… |
|
|
49
49
|
| `AgenticProcessCompletion` | type | `dist/nodes/process/flow/spec.d.ts:194-232` | Supporting types | Whether an Agentic Process step waits for the process's result. |
|
|
50
50
|
| `AgenticProcessInputs` | type | `dist/nodes/process/flow/spec.d.ts:233-234` | Option shapes | What `agenticProcess()` takes: the shared fields plus the completion policy. |
|
|
51
51
|
| `AgenticProcessInputsBase` | interface | `dist/nodes/process/flow/spec.d.ts:137-193` | Option shapes | 7 field(s) |
|
|
52
52
|
| `AgentInputs` | interface | `dist/nodes/process/flow/spec.d.ts:242-337` | Option shapes | What `agent()` takes: the agent resource to start, its arguments, and the output fields a read may name. |
|
|
53
53
|
| `AgentLocation` | type | `dist/nodes/process/flow/spec.d.ts:240-241` | Supporting types | Where a published agent lives: deployed to a folder (`'published'`) or a sibling project of the same solution… |
|
|
54
|
-
| `AgentMemoryRef` | interface | `dist/core/actions.d.ts:
|
|
55
|
-
| `AgentResourcePlacement` | interface | `dist/core/actions.d.ts:
|
|
54
|
+
| `AgentMemoryRef` | interface | `dist/core/actions.d.ts:630-654` | 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:498-533` | 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
58
|
| `apiWorkflow` | function | `dist/nodes/process/flow/factories.d.ts:53-87` | Actions | Invoke a deployed API workflow — a coded workflow published to Orchestrator, run as a serverless job rather than by a… |
|
|
59
59
|
| `ApiWorkflowInputs` | interface | `dist/nodes/process/flow/spec.d.ts:70-101` | 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
|
-
| `ArmBuilder` | class | `dist/flow-sdk.d.ts:
|
|
62
|
-
| `AskedField` | interface | `dist/core/actions.d.ts:221-
|
|
63
|
-
| `at` | function | `dist/flow-sdk.d.ts:
|
|
61
|
+
| `ArmBuilder` | class | `dist/flow-sdk.d.ts:1358-1381` | 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:221-240` | Supporting types | A value the reviewer FILLS IN: read downstream with `out('<step>', '<id>')`. |
|
|
63
|
+
| `at` | function | `dist/flow-sdk.d.ts:693-721` | Flow construction | A node's layout at a canvas position — the short form of a NodeLayout for the `nodes` map of FlowBuilder.layout. |
|
|
64
64
|
| `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… |
|
|
65
65
|
| `BatchTransformInputs` | interface | `dist/nodes/ai-patterns/flow/spec.d.ts:48-63` | Option shapes | 4 field(s) |
|
|
66
66
|
| `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… |
|
|
67
|
-
| `BuiltEntryPoint` | interface | `dist/flow-sdk.d.ts:
|
|
68
|
-
| `BuiltFlow` | interface | `dist/flow-sdk.d.ts:
|
|
69
|
-
| `BuiltinToolName` | type | `dist/core/actions.d.ts:
|
|
70
|
-
| `BuiltinToolRef` | interface | `dist/core/actions.d.ts:
|
|
71
|
-
| `BuiltInValidatorGuardrail` | interface | `dist/core/actions.d.ts:
|
|
67
|
+
| `BuiltEntryPoint` | interface | `dist/flow-sdk.d.ts:821-833` | Supporting types | One additional flow root, built by `.entryPoint()`. |
|
|
68
|
+
| `BuiltFlow` | interface | `dist/flow-sdk.d.ts:834-881` | Supporting types | 17 field(s) |
|
|
69
|
+
| `BuiltinToolName` | type | `dist/core/actions.d.ts:486-487` | Supporting types | The three platform-shipped built-in tools (fixed registry types). |
|
|
70
|
+
| `BuiltinToolRef` | interface | `dist/core/actions.d.ts:655-675` | Supporting types | A platform built-in tool. |
|
|
71
|
+
| `BuiltInValidatorGuardrail` | interface | `dist/core/actions.d.ts:443-484` | Supporting types | A platform-shipped validator, configured by parameters. |
|
|
72
72
|
| `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. |
|
|
73
73
|
| `CaseValue` | type | `dist/flow-sdk.d.ts:341-342` | Supporting types | A value a `.switch` case compares the discriminant against. |
|
|
74
74
|
| `ChildFlow` | type | `dist/flow-sdk.d.ts:57-60` | Supporting types | Anything `subflow()` accepts as the child: a builder, or an already-built flow. |
|
|
75
|
-
| `ClientSideToolRef` | interface | `dist/core/actions.d.ts:
|
|
76
|
-
| `connector` | function | `dist/core/actions.d.ts:
|
|
77
|
-
| `connector` | function | `dist/core/actions.d.ts:
|
|
75
|
+
| `ClientSideToolRef` | interface | `dist/core/actions.d.ts:584-599` | Supporting types | A CLIENT-side tool: the agent asks the CALLING application to run it and hand the answer back… |
|
|
76
|
+
| `connector` | function | `dist/core/actions.d.ts:1035-1058` | Actions | Declare an Integration Service connector action — the typed form, where a generated descriptor supplies the nodeType and… |
|
|
77
|
+
| `connector` | function | `dist/core/actions.d.ts:1059-1075` | Actions | Stringly form, for a connector with no prepared module — `connector('uipath-salesforce-slack',… |
|
|
78
78
|
| `ConnectorDescriptor` | type | `dist/core/connectors.d.ts:89-97` | Generated descriptors | A generated, typed connector descriptor: ConnectorMeta branded with phantom input/output types. |
|
|
79
79
|
| `ConnectorLookupValue` | type | `dist/core/connectors.d.ts:50-59` | Generated descriptors | ConnectorValue for a field that also accepts an unresolved lookup. |
|
|
80
80
|
| `ConnectorMeta` | interface | `dist/core/connectors.d.ts:60-88` | Generated descriptors | Runtime metadata a generated descriptor carries. |
|
|
81
81
|
| `ConnectorOpts` | interface | `dist/core/actions.d.ts:13-56` | Option shapes | 4 field(s) |
|
|
82
|
-
| `ConnectorToolRef` | interface | `dist/core/actions.d.ts:
|
|
82
|
+
| `ConnectorToolRef` | interface | `dist/core/actions.d.ts:676-713` | Supporting types | An Integration Service connector operation as a tool — e.g. "create a Jira issue". |
|
|
83
83
|
| `ConnectorValue` | type | `dist/core/connectors.d.ts:26-49` | Generated descriptors | What a generated `Inputs` property accepts: the value, or an expression. |
|
|
84
|
-
| `ContextIndexRef` | interface | `dist/core/actions.d.ts:
|
|
84
|
+
| `ContextIndexRef` | interface | `dist/core/actions.d.ts:864-904` | Supporting types | One Context Grounding index an inline agent is grounded on, placed in the flow by AgentResourcePlacement. |
|
|
85
85
|
| `ContributionContext` | interface | `dist/core/node-classes.d.ts:68-79` | Supporting types | What the serializer tells a contributor before asking for its contribution. |
|
|
86
86
|
| `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. |
|
|
87
87
|
| `ControlFormFieldType` | type | `dist/core/actions.d.ts:64-72` | Supporting types | The platform's choice-control spellings of a field type. |
|
|
@@ -93,7 +93,7 @@ could hand you spans for a version you do not have.
|
|
|
93
93
|
| `conversationTrigger` | function | `dist/flow-sdk.d.ts:289-315` | Flow construction | Start the flow when a new CONVERSATION is created (`core.trigger.conversation`) — the entry point for a chat-driven… |
|
|
94
94
|
| `createOutgoingCall` | function | `dist/nodes/agent/flow/factories.d.ts:9-25` | Actions | Place an outgoing phone call (`uipath.conversational.voice.create-outgoing-call`) and get back the `callContext` every… |
|
|
95
95
|
| `CreateOutgoingCallInputs` | interface | `dist/nodes/agent/flow/spec.d.ts:86-95` | Option shapes | What `createOutgoingCall()` takes: the two numbers, in E.164. |
|
|
96
|
-
| `CustomGuardrail` | interface | `dist/core/actions.d.ts:
|
|
96
|
+
| `CustomGuardrail` | interface | `dist/core/actions.d.ts:430-442` | Supporting types | A rule-based guardrail you author in place. |
|
|
97
97
|
| `dataFabricCreate` | function | `dist/nodes/data-fabric/flow/factories.d.ts:56-79` | Actions | Create an entity record in Data Fabric (`core.datafabric.create`). |
|
|
98
98
|
| `DataFabricCreateInputs` | interface | `dist/nodes/data-fabric/flow/spec.d.ts:129-159` | Option shapes | 4 field(s) |
|
|
99
99
|
| `dataFabricDelete` | function | `dist/nodes/data-fabric/flow/factories.d.ts:96-113` | Actions | Delete an entity record from Data Fabric (`core.datafabric.delete`). |
|
|
@@ -112,37 +112,37 @@ could hand you spans for a version you do not have.
|
|
|
112
112
|
| `DELAY_PRESETS` | const | `dist/nodes/delay/flow/spec.d.ts:6-13` | Actions | The twelve durations the designer's dropdown offers. |
|
|
113
113
|
| `DelayInputs` | type | `dist/nodes/delay/flow/spec.d.ts:14-35` | Option shapes | |
|
|
114
114
|
| `descriptor` | function | `dist/core/connectors.d.ts:98-110` | Generated descriptors | Brand a descriptor literal with its input/output types (zero runtime cost). |
|
|
115
|
-
| `dim` | function | `dist/flow-sdk.d.ts:
|
|
115
|
+
| `dim` | function | `dist/flow-sdk.d.ts:722-744` | Flow construction | A node's size on the canvas, in pixels — the third argument of at. |
|
|
116
116
|
| `documentClassify` | function | `dist/nodes/document/flow/factories.d.ts:8-16` | Actions | Classify a document into a document type (`uipath.document.classify`). |
|
|
117
117
|
| `DocumentClassifyInputs` | interface | `dist/nodes/document/flow/spec.d.ts:9-18` | Option shapes | 4 field(s) |
|
|
118
118
|
| `DocValidationInputs` | interface | `dist/nodes/hitl/flow/spec.d.ts:70-93` | Option shapes | The Document Validation task's subject — `variant: 'document-validation'` only. |
|
|
119
|
-
| `DoWhileOptions` | interface | `dist/flow-sdk.d.ts:
|
|
119
|
+
| `DoWhileOptions` | interface | `dist/flow-sdk.d.ts:547-556` | Option shapes | Do-while options. |
|
|
120
120
|
| `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… |
|
|
121
121
|
| `DynamicExtractInputs` | interface | `dist/nodes/document/flow/spec.d.ts:19-53` | Option shapes | 5 field(s) |
|
|
122
|
-
| `EdgeRoute` | interface | `dist/flow-sdk.d.ts:
|
|
122
|
+
| `EdgeRoute` | interface | `dist/flow-sdk.d.ts:745-759` | Supporting types | One edge's route: user-dragged bends and/or the auto-router's waypoints. |
|
|
123
123
|
| `endCall` | function | `dist/nodes/agent/flow/factories.d.ts:26-33` | Actions | Hang up (`uipath.conversational.voice.end-call`). |
|
|
124
124
|
| `EndCallInputs` | interface | `dist/nodes/agent/flow/spec.d.ts:96-104` | Option shapes | What `endCall()` takes: the call to hang up. |
|
|
125
125
|
| `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` —… |
|
|
126
126
|
| `err` | function | `dist/core/expr.d.ts:153-246` | Expressions and types | Reference a FAILED step's error → `$vars.<step>.error[.<field>]`. |
|
|
127
127
|
| `ErrorEnvelopeField` | type | `dist/core/expr.d.ts:142-152` | Supporting types | The fields a failure envelope carries. |
|
|
128
|
-
| `EscalationRef` | interface | `dist/core/actions.d.ts:
|
|
129
|
-
| `EventFilter` | type | `dist/core/actions.d.ts:
|
|
130
|
-
| `EventSubscription` | interface | `dist/core/actions.d.ts:
|
|
128
|
+
| `EscalationRef` | interface | `dist/core/actions.d.ts:797-863` | Supporting types | One escalation an inline agent may raise — an Action Center app task a human completes (the `coded-action-app` variant,… |
|
|
129
|
+
| `EventFilter` | type | `dist/core/actions.d.ts:1076-1117` | Supporting types | One filter condition on the event payload. |
|
|
130
|
+
| `EventSubscription` | interface | `dist/core/actions.d.ts:1166-1207` | Option shapes | What a connector event subscribes to. |
|
|
131
131
|
| `Expr` | class | `dist/core/expr.d.ts:11-21` | Supporting types | A Flow expression. |
|
|
132
132
|
| `FieldMapping` | interface | `dist/nodes/transform/flow/spec.d.ts:27-34` | Supporting types | 3 field(s) |
|
|
133
133
|
| `FilterCondition` | type | `dist/nodes/transform/flow/spec.d.ts:10-11` | Supporting types | Comparison a filter rule applies to a field. |
|
|
134
134
|
| `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. |
|
|
135
135
|
| `FilterRule` | interface | `dist/nodes/transform/flow/spec.d.ts:12-24` | Supporting types | 3 field(s) |
|
|
136
|
-
| `flow` | function | `dist/flow-sdk.d.ts:
|
|
136
|
+
| `flow` | function | `dist/flow-sdk.d.ts:1762-1777` | Flow construction | Start building a flow with the given id. |
|
|
137
137
|
| `FlowAction` | class | `dist/core/node-classes.d.ts:162-168` | Supporting types | A node placed as a step — pass an instance to `.step(name, …)`. |
|
|
138
138
|
| `FlowActionSpec` | type | `dist/flow-sdk.d.ts:55-56` | Supporting types | What `.step()` accepts here: the shared actions plus this SDK's subflow. |
|
|
139
|
-
| `FlowActionSpecs` | interface | `dist/core/actions.d.ts:
|
|
140
|
-
| `FlowBuilder` | class | `dist/flow-sdk.d.ts:
|
|
141
|
-
| `FlowLayout` | interface | `dist/flow-sdk.d.ts:
|
|
139
|
+
| `FlowActionSpecs` | interface | `dist/core/actions.d.ts:905-942` | Supporting types | Every action kind, keyed by kind, to the body of its spec — the arm's fields other than `kind`. |
|
|
140
|
+
| `FlowBuilder` | class | `dist/flow-sdk.d.ts:1382-1761` | Builders | 15 member(s) |
|
|
141
|
+
| `FlowLayout` | interface | `dist/flow-sdk.d.ts:807-820` | Supporting types | Designer layout for a flow, keyed by AUTHOR-level ids: node entries by step name (plus the trigger id and `end`), edge… |
|
|
142
142
|
| `FlowNode` | class | `dist/core/node-classes.d.ts:126-161` | Supporting types | The abstract root of every definition-backed node the builder can place. |
|
|
143
143
|
| `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. |
|
|
144
144
|
| `FlowTrigger` | class | `dist/core/node-classes.d.ts:169-175` | Supporting types | A node that starts the flow — pass an instance to `.trigger(…)`. |
|
|
145
|
-
| `FormField` | type | `dist/core/actions.d.ts:
|
|
145
|
+
| `FormField` | type | `dist/core/actions.d.ts:259` | Supporting types | |
|
|
146
146
|
| `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… |
|
|
147
147
|
| `FormFieldControlType` | type | `dist/core/actions.d.ts:105-112` | Supporting types | How a form field renders (`@uipath/hitl-schema-types` `controlType`). |
|
|
148
148
|
| `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… |
|
|
@@ -150,12 +150,12 @@ could hand you spans for a version you do not have.
|
|
|
150
150
|
| `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… |
|
|
151
151
|
| `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… |
|
|
152
152
|
| `formTrigger` | function | `dist/flow-sdk.d.ts:260-288` | Flow construction | Start the flow from a FORM a person fills in (`core.trigger.form`) — the platform renders one field per flow input and… |
|
|
153
|
-
| `GuardrailAction` | type | `dist/core/actions.d.ts:
|
|
154
|
-
| `GuardrailFieldReference` | interface | `dist/core/actions.d.ts:
|
|
155
|
-
| `GuardrailFieldSelector` | type | `dist/core/actions.d.ts:
|
|
156
|
-
| `GuardrailRule` | type | `dist/core/actions.d.ts:
|
|
157
|
-
| `GuardrailScope` | type | `dist/core/actions.d.ts:
|
|
158
|
-
| `GuardrailSelector` | interface | `dist/core/actions.d.ts:
|
|
153
|
+
| `GuardrailAction` | type | `dist/core/actions.d.ts:419-429` | Supporting types | What happens when a guardrail trips. |
|
|
154
|
+
| `GuardrailFieldReference` | interface | `dist/core/actions.d.ts:386-391` | Supporting types | A field the rule or filter action points at. |
|
|
155
|
+
| `GuardrailFieldSelector` | type | `dist/core/actions.d.ts:392-398` | Supporting types | All fields, or a named few. |
|
|
156
|
+
| `GuardrailRule` | type | `dist/core/actions.d.ts:399-418` | Supporting types | One condition of a custom guardrail. |
|
|
157
|
+
| `GuardrailScope` | type | `dist/core/actions.d.ts:378-379` | Supporting types | Where a guardrail applies: the whole agent, its LLM calls, or its tools. |
|
|
158
|
+
| `GuardrailSelector` | interface | `dist/core/actions.d.ts:380-385` | Supporting types | Which artifacts inside the scope the guardrail watches. |
|
|
159
159
|
| `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… |
|
|
160
160
|
| `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'`… |
|
|
161
161
|
| `HitlChannel` | type | `dist/nodes/hitl/flow/spec.d.ts:10-15` | Supporting types | Where the task is delivered. |
|
|
@@ -167,16 +167,16 @@ could hand you spans for a version you do not have.
|
|
|
167
167
|
| `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. |
|
|
168
168
|
| `HttpInputs` | type | `dist/nodes/http/flow/spec.d.ts:125-142` | Option shapes | |
|
|
169
169
|
| `HttpInputsBase` | interface | `dist/nodes/http/flow/spec.d.ts:24-124` | Option shapes | 11 field(s) |
|
|
170
|
-
| `HttpRequestToolRef` | interface | `dist/core/actions.d.ts:
|
|
170
|
+
| `HttpRequestToolRef` | interface | `dist/core/actions.d.ts:600-629` | Supporting types | The built-in HTTP-request tool (`uipath.agent.resource.tool.builtin.httprequest`): the agent performs an HTTP call. |
|
|
171
171
|
| `inlineAgent` | function | `dist/nodes/agent/flow/factories.d.ts:84-134` | Actions | Declare an INLINE AUTONOMOUS AGENT — an agent defined inside this flow's own project rather than published to… |
|
|
172
|
-
| `InlineAgentFieldType` | type | `dist/core/actions.d.ts:
|
|
172
|
+
| `InlineAgentFieldType` | type | `dist/core/actions.d.ts:358-359` | Supporting types | A JSON-schema-ish type for one field of an inline agent's input/output schema. |
|
|
173
173
|
| `InlineAgentInputs` | interface | `dist/nodes/agent/flow/spec.d.ts:163-424` | Option shapes | What `inlineAgent()` takes: the model and prompts, the inputs and `returns`, the run settings, and the resources the… |
|
|
174
|
-
| `InOutField` | interface | `dist/core/actions.d.ts:
|
|
174
|
+
| `InOutField` | interface | `dist/core/actions.d.ts:241-258` | Supporting types | A value the reviewer READS **and can correct**: pre-filled from the flow, editable on the form, and the (possibly… |
|
|
175
175
|
| `input` | function | `dist/core/expr.d.ts:44-61` | Expressions and types | Reference a flow input by name → `$vars.<triggerId>.output.<name>`. |
|
|
176
176
|
| `isLookupToken` | function | `dist/core/lookups.d.ts:53-54` | Generated descriptors | True when `v` is an unresolved LookupToken. |
|
|
177
|
-
| `ixpExtract` | function | `dist/core/actions.d.ts:
|
|
178
|
-
| `IxpExtractInputs` | interface | `dist/core/actions.d.ts:
|
|
179
|
-
| `IxpToolRef` | interface | `dist/core/actions.d.ts:
|
|
177
|
+
| `ixpExtract` | function | `dist/core/actions.d.ts:980-1034` | Actions | Extract fields from a document with a published IxP project — the platform's **Extract** node (`uipath.ixp.*`, service… |
|
|
178
|
+
| `IxpExtractInputs` | interface | `dist/core/actions.d.ts:277-351` | Option shapes | 9 field(s) |
|
|
179
|
+
| `IxpToolRef` | interface | `dist/core/actions.d.ts:758-796` | Supporting types | A published IxP (Intelligent eXtraction Platform) project as a tool — the agent decides when to extract a document and… |
|
|
180
180
|
| `js` | function | `dist/core/expr.d.ts:247-282` | Expressions and types | Build a raw JS *expression* (a condition or computation). |
|
|
181
181
|
| `lit` | function | `dist/core/expr.d.ts:22-28` | Expressions and types | A constant value baked directly into a node input. |
|
|
182
182
|
| `lookup` | function | `dist/core/lookups.d.ts:95-102` | Generated descriptors | Begin resolving a lookup field on a generated descriptor. |
|
|
@@ -191,22 +191,23 @@ could hand you spans for a version you do not have.
|
|
|
191
191
|
| `lookupSpecOf` | function | `dist/core/lookups.d.ts:221-228` | Generated descriptors | The LookupSpec for one field, or `undefined` when it earns no helper. |
|
|
192
192
|
| `LookupStrategy` | type | `dist/core/lookups.d.ts:1-10` | Generated descriptors | How `prepare` should retrieve the collection, chosen from the metadata. |
|
|
193
193
|
| `LookupToken` | interface | `dist/core/lookups.d.ts:37-52` | Generated descriptors | An unresolved lookup: what `.byEmail(…)` returns. |
|
|
194
|
-
| `LoopOptions` | interface | `dist/flow-sdk.d.ts:
|
|
194
|
+
| `LoopOptions` | interface | `dist/flow-sdk.d.ts:522-546` | Option shapes | Loop-specific options. |
|
|
195
195
|
| `manual` | function | `dist/flow-sdk.d.ts:183-192` | Flow construction | The manual trigger, explicitly. |
|
|
196
|
-
| `McpToolRef` | interface | `dist/core/actions.d.ts:
|
|
196
|
+
| `McpToolRef` | interface | `dist/core/actions.d.ts:534-562` | Supporting types | An MCP server the agent may call tools on. |
|
|
197
197
|
| `mock` | function | `dist/nodes/mock/flow/factories.d.ts:6-45` | Actions | Declare a PLACEHOLDER step — "a real node goes here later". |
|
|
198
198
|
| `NodeContribution` | interface | `dist/core/node-classes.d.ts:102-125` | Supporting types | One validated construct, returned by FlowNode.contribute. |
|
|
199
|
-
| `NodeLayout` | interface | `dist/flow-sdk.d.ts:
|
|
199
|
+
| `NodeLayout` | interface | `dist/flow-sdk.d.ts:678-692` | Supporting types | One node's designer layout: canvas position, and optionally size and collapsed state. |
|
|
200
200
|
| `NodeOptions` | interface | `dist/flow-sdk.d.ts:393-446` | Option shapes | Options shared by every builder method that creates a definition-backed node: `version` selects the exact node… |
|
|
201
201
|
| `onEvent` | function | `dist/flow-sdk.d.ts:193-231` | Flow construction | Start the flow when a connector event fires — e.g. an email arriving in a mailbox folder. |
|
|
202
202
|
| `onEvent` | function | `dist/flow-sdk.d.ts:232-239` | Flow construction | Stringly form, for an event with no prepared module. |
|
|
203
203
|
| `out` | function | `dist/core/expr.d.ts:73-94` | Expressions and types | Reference an upstream step's output → `$vars.<step>.output[.<path>]`. |
|
|
204
204
|
| `Outcome` | type | `dist/nodes/hitl/flow/spec.d.ts:94-113` | Supporting types | One completion button. |
|
|
205
205
|
| `OutputColumn` | interface | `dist/nodes/ai-patterns/flow/spec.d.ts:41-47` | Supporting types | One column Batch Transform appends to the CSV. |
|
|
206
|
+
| `ParallelOptions` | interface | `dist/flow-sdk.d.ts:447-470` | Option shapes | The options of `.parallel()`: the join's NodeOptions, plus the fork node when the flow has one. |
|
|
206
207
|
| `PortArm` | interface | `dist/flow-sdk.d.ts:380-392` | Supporting types | One arm of a built `.stepSwitch` — the same shape as SwitchArm, but `value` names an exit the ACTION declares (a… |
|
|
207
|
-
| `ProcessLocation` | type | `dist/core/actions.d.ts:
|
|
208
|
-
| `ProcessToolKind` | type | `dist/core/actions.d.ts:
|
|
209
|
-
| `ProcessToolRef` | interface | `dist/core/actions.d.ts:
|
|
208
|
+
| `ProcessLocation` | type | `dist/core/actions.d.ts:352-357` | Supporting types | Where a process resource lives: deployed to an Orchestrator folder (`'published'`, the default) or a sibling project of… |
|
|
209
|
+
| `ProcessToolKind` | type | `dist/core/actions.d.ts:714-727` | Supporting types | The tool kinds that wrap a DEPLOYED tenant resource. |
|
|
210
|
+
| `ProcessToolRef` | interface | `dist/core/actions.d.ts:728-757` | Supporting types | A deployed tenant resource the agent may invoke. |
|
|
210
211
|
| `publishedFunction` | function | `dist/nodes/process/flow/factories.d.ts:88-112` | Actions | Invoke a published Orchestrator **Function** — a deployed unit of code run as one step (`uipath.core.function.<key>`,… |
|
|
211
212
|
| `PublishedFunctionInputs` | interface | `dist/nodes/process/flow/spec.d.ts:102-136` | Option shapes | A published Orchestrator **Function** — a small, single-purpose unit of code deployed as its own resource and invoked as… |
|
|
212
213
|
| `queueItem` | function | `dist/nodes/queue/flow/factories.d.ts:4-49` | Actions | Declare an Orchestrator QUEUE ITEM step. |
|
|
@@ -215,12 +216,12 @@ could hand you spans for a version you do not have.
|
|
|
215
216
|
| `ran` | function | `dist/core/expr.d.ts:95-141` | Expressions and types | Did this step run? |
|
|
216
217
|
| `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… |
|
|
217
218
|
| `RawReference` | type | `dist/core/lookups.d.ts:212-220` | Supporting types | |
|
|
218
|
-
| `RemoteA2aToolRef` | interface | `dist/core/actions.d.ts:
|
|
219
|
+
| `RemoteA2aToolRef` | interface | `dist/core/actions.d.ts:563-583` | Supporting types | A remote A2A (agent-to-agent) endpoint the agent may delegate to. |
|
|
219
220
|
| `resolvedEventValue` | function | `dist/core/lookups.d.ts:185-201` | Generated descriptors | resolvedValue for a token on an event's `where`. |
|
|
220
221
|
| `resolvedValue` | function | `dist/core/lookups.d.ts:177-184` | Generated descriptors | The recorded id for a token, or `undefined`. |
|
|
221
222
|
| `resolveEventWhere` | function | `dist/core/lookups.d.ts:229-246` | Generated descriptors | An event subscription's `where` with every lookup token swapped for the id `registry prepare --resolve` recorded, or a… |
|
|
222
|
-
| `ReturnFieldType` | type | `dist/core/actions.d.ts:
|
|
223
|
-
| `ReturnOptions` | interface | `dist/flow-sdk.d.ts:
|
|
223
|
+
| `ReturnFieldType` | type | `dist/core/actions.d.ts:360-377` | Supporting types | A JSON-schema-ish type for one field of a step's declared `returns`. |
|
|
224
|
+
| `ReturnOptions` | interface | `dist/flow-sdk.d.ts:480-521` | Option shapes | `.return(...)`-specific options. |
|
|
224
225
|
| `rpaWorkflow` | function | `dist/nodes/process/flow/factories.d.ts:8-52` | Actions | Invoke a deployed RPA (robotic process automation) workflow — a classic UI-automation process, published to… |
|
|
225
226
|
| `RpaWorkflowInputs` | interface | `dist/nodes/process/flow/spec.d.ts:11-69` | Option shapes | 7 field(s) |
|
|
226
227
|
| `SCHEDULE_PRESETS` | const | `dist/flow-sdk.d.ts:130-137` | Flow construction | The eight intervals the designer offers in its Frequency dropdown. |
|
|
@@ -235,19 +236,19 @@ could hand you spans for a version you do not have.
|
|
|
235
236
|
| `sendMessage` | function | `dist/nodes/conversation/flow/factories.d.ts:8-26` | Actions | Post an assistant message into a live conversation (`uipath.conversational.send-message`). |
|
|
236
237
|
| `SendMessageInputs` | interface | `dist/nodes/conversation/flow/spec.d.ts:8-27` | Option shapes | 4 field(s) |
|
|
237
238
|
| `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. |
|
|
238
|
-
| `Step` | type | `dist/flow-sdk.d.ts:
|
|
239
|
-
| `StepList` | class | `dist/flow-sdk.d.ts:
|
|
240
|
-
| `STICKY_NOTE_COLORS` | const | `dist/flow-sdk.d.ts:
|
|
241
|
-
| `StickyNote` | interface | `dist/flow-sdk.d.ts:
|
|
242
|
-
| `StickyNoteColor` | type | `dist/flow-sdk.d.ts:
|
|
243
|
-
| `subflow` | function | `dist/flow-sdk.d.ts:
|
|
239
|
+
| `Step` | type | `dist/flow-sdk.d.ts:557-677` | Supporting types | |
|
|
240
|
+
| `StepList` | class | `dist/flow-sdk.d.ts:882-1357` | Builders | Collects a sequence of steps. |
|
|
241
|
+
| `STICKY_NOTE_COLORS` | const | `dist/flow-sdk.d.ts:760-765` | Flow construction | The designer's sticky-note palette. |
|
|
242
|
+
| `StickyNote` | interface | `dist/flow-sdk.d.ts:772-806` | Supporting types | A canvas sticky note — free text pinned to the diagram, for the humans reading it. |
|
|
243
|
+
| `StickyNoteColor` | type | `dist/flow-sdk.d.ts:766-771` | Supporting types | A sticky note's swatch. |
|
|
244
|
+
| `subflow` | function | `dist/flow-sdk.d.ts:1778-1817` | Flow construction | Run another flow as one step, and read back what it returns. |
|
|
244
245
|
| `SubflowSpec` | interface | `dist/flow-sdk.d.ts:47-54` | Supporting types | A step that runs a child flow. |
|
|
245
246
|
| `summarize` | function | `dist/nodes/ai-patterns/flow/factories.d.ts:8-48` | Actions | Summarize a document with citations — the platform's **Summarize** node. |
|
|
246
247
|
| `SummarizeInputs` | interface | `dist/nodes/ai-patterns/flow/spec.d.ts:8-40` | Option shapes | 3 field(s) |
|
|
247
248
|
| `SwitchArm` | interface | `dist/flow-sdk.d.ts:360-379` | Supporting types | One arm of a built `.switch` (the serializer's view: body already collected). |
|
|
248
249
|
| `SwitchCase` | type | `dist/flow-sdk.d.ts:343-359` | Supporting types | One case of `.switch(name, on, cases)`: either `{ value }`, taken when `on === value`, or `{ when }`, taken when its own… |
|
|
249
250
|
| `tmpl` | function | `dist/core/expr.d.ts:283-293` | Expressions and types | Build a JS *string template* (for URLs, messages, etc.). |
|
|
250
|
-
| `ToolRef` | type | `dist/core/actions.d.ts:
|
|
251
|
+
| `ToolRef` | type | `dist/core/actions.d.ts:488-497` | Supporting types | One tool on an inline agent — a discriminated union over the kinds the tenant's registry actually serves… |
|
|
251
252
|
| `transform` | function | `dist/nodes/transform/flow/factories.d.ts:7-52` | Actions | Declare a Transform action — a chain of declarative operations over a collection. |
|
|
252
253
|
| `Transformation` | type | `dist/nodes/transform/flow/spec.d.ts:25-26` | Supporting types | What a map does to a field's value. |
|
|
253
254
|
| `TransformInputs` | interface | `dist/nodes/transform/flow/spec.d.ts:84-108` | Option shapes | 3 field(s) |
|
|
@@ -256,7 +257,7 @@ could hand you spans for a version you do not have.
|
|
|
256
257
|
| `triggerDescriptor` | function | `dist/core/connectors.d.ts:139-151` | Generated descriptors | Brand a trigger descriptor literal with its where/output types. |
|
|
257
258
|
| `TriggerDescriptor` | type | `dist/core/connectors.d.ts:130-138` | Generated descriptors | A generated, typed connector-trigger descriptor: TriggerMeta branded with phantom `where`/output types. |
|
|
258
259
|
| `TriggerMeta` | interface | `dist/core/connectors.d.ts:120-129` | Generated descriptors | Runtime metadata a generated trigger descriptor carries. |
|
|
259
|
-
| `TriggerOptions` | interface | `dist/core/actions.d.ts:
|
|
260
|
+
| `TriggerOptions` | interface | `dist/core/actions.d.ts:1118-1165` | Option shapes | The typed `onEvent`/`waitForEvent` options — everything an EventSubscription carries except `connector`/`event`, which… |
|
|
260
261
|
| `TriggerSpec` | type | `dist/flow-sdk.d.ts:164-182` | Supporting types | What starts the flow. |
|
|
261
262
|
| `TypeDesc` | type | `dist/core/expr.d.ts:385` | Supporting types | |
|
|
262
263
|
| `types` | const | `dist/core/expr.d.ts:369-384` | Expressions and types | Variable type descriptors (map to Flow variable `type` values). |
|
|
@@ -268,8 +269,8 @@ could hand you spans for a version you do not have.
|
|
|
268
269
|
| `VoiceAgentInputs` | interface | `dist/nodes/agent/flow/spec.d.ts:128-162` | Option shapes | What `voiceAgent()` takes: the agent's instructions, the call it joins, and how it sounds. |
|
|
269
270
|
| `VoiceSettings` | interface | `dist/nodes/agent/flow/spec.d.ts:105-127` | Supporting types | The audio settings a voice agent speaks with. |
|
|
270
271
|
| `voiceTrigger` | function | `dist/flow-sdk.d.ts:316-340` | Flow construction | Start the flow when a phone call comes IN (`core.trigger.voice`). |
|
|
271
|
-
| `waitForEvent` | function | `dist/core/actions.d.ts:
|
|
272
|
-
| `waitForEvent` | function | `dist/core/actions.d.ts:
|
|
272
|
+
| `waitForEvent` | function | `dist/core/actions.d.ts:1217-1252` | Actions | Wait mid-flow until a connector event fires, then continue with its payload — the typed form, where a generated trigger… |
|
|
273
|
+
| `waitForEvent` | function | `dist/core/actions.d.ts:1253-1260` | Actions | Stringly form, for an event with no prepared module. |
|
|
273
274
|
| `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… |
|
|
274
275
|
| `WaitForMessageInputs` | interface | `dist/nodes/conversation/flow/spec.d.ts:28-36` | Option shapes | 2 field(s) |
|
|
275
276
|
|
|
@@ -315,8 +316,8 @@ could hand you spans for a version you do not have.
|
|
|
315
316
|
| `EscalationOpts` | interface | `dist/case/case-sdk.d.ts:127-139` | Option shapes | 4 field(s) |
|
|
316
317
|
| `EscalationRecipient` | interface | `dist/case/case-sdk.d.ts:119-126` | Supporting types | Who an escalation notifies. |
|
|
317
318
|
| `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`). |
|
|
318
|
-
| `EventFilter` | type | `dist/core/actions.d.ts:
|
|
319
|
-
| `EventSubscription` | interface | `dist/core/actions.d.ts:
|
|
319
|
+
| `EventFilter` | type | `dist/core/actions.d.ts:1076-1117` | Supporting types | One filter condition on the event payload. |
|
|
320
|
+
| `EventSubscription` | interface | `dist/core/actions.d.ts:1166-1207` | Option shapes | What a connector event subscribes to. |
|
|
320
321
|
| `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. |
|
|
321
322
|
| `eventTrigger` | function | `dist/case/case-sdk.d.ts:305-311` | Case authoring | An Integration Service event trigger in placeholder or stringly-resolved form. |
|
|
322
323
|
| `EventTriggerOpts` | interface | `dist/case/case-sdk.d.ts:241-281` | Option shapes | 5 field(s) |
|
|
@@ -352,7 +353,7 @@ could hand you spans for a version you do not have.
|
|
|
352
353
|
| `toUser` | function | `dist/case/case-sdk.d.ts:150-157` | Case authoring | An escalation recipient that is a single user. |
|
|
353
354
|
| `TriggerDescriptor` | type | `dist/core/connectors.d.ts:130-138` | Supporting types | A generated, typed connector-trigger descriptor: TriggerMeta branded with phantom `where`/output types. |
|
|
354
355
|
| `TriggerMeta` | interface | `dist/core/connectors.d.ts:120-129` | Supporting types | Runtime metadata a generated trigger descriptor carries. |
|
|
355
|
-
| `TriggerOptions` | interface | `dist/core/actions.d.ts:
|
|
356
|
+
| `TriggerOptions` | interface | `dist/core/actions.d.ts:1118-1165` | Option shapes | The typed `onEvent`/`waitForEvent` options — everything an EventSubscription carries except `connector`/`event`, which… |
|
|
356
357
|
| `TypeDesc` | type | `dist/core/expr.d.ts:385` | Supporting types | |
|
|
357
358
|
| `UnresolvedReferenceTaskKind` | type | `dist/case/case-sdk.d.ts:376-377` | Supporting types | Published-resource task kinds that the Case schema permits as unresolved skeletons. |
|
|
358
359
|
| `WaitConnectorPlaceholderSpec` | interface | `dist/case/case-sdk.d.ts:378-388` | Supporting types | A `wait-for-connector` subscription: suspend on an Integration Service event. |
|
|
@@ -404,7 +405,7 @@ could hand you spans for a version you do not have.
|
|
|
404
405
|
| `errorSchema` | const | `dist/bpmn/bpmn-sdk.d.ts:3588-3629` | BPMN authoring | The `Error` variable's shape — the platform's own error envelope. |
|
|
405
406
|
| `errorSchemaWithResponse` | const | `dist/bpmn/bpmn-sdk.d.ts:3630-3662` | BPMN authoring | The same envelope plus `response` — what a node whose failure carries a payload writes, and what the same source calls… |
|
|
406
407
|
| `EventDef` | type | `dist/bpmn/bpmn-sdk.d.ts:54-72` | Supporting types | The resolved event definition attached to an event node. |
|
|
407
|
-
| `EventFilter` | type | `dist/core/actions.d.ts:
|
|
408
|
+
| `EventFilter` | type | `dist/core/actions.d.ts:1076-1117` | Supporting types | One filter condition on the event payload. |
|
|
408
409
|
| `EventKind` | type | `dist/bpmn/bpmn-sdk.d.ts:75-76` | Supporting types | The four non-boundary event element kinds a BpmnNode can be. |
|
|
409
410
|
| `EventSubProcessOpts` | interface | `dist/bpmn/bpmn-sdk.d.ts:1872-1934` | Option shapes | Options for ScopeBuilder.eventSubProcess. |
|
|
410
411
|
| `ExtensionPayload` | interface | `dist/bpmn/bpmn-sdk.d.ts:574-610` | Supporting types | An extension payload carried by an element the payload does not describe. |
|