@uipath/maestro-builder-sdk 6.6.1 → 6.8.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 +53 -46
- package/dist/api-members.md +69 -52
- package/dist/bpmn/registry-fallback.d.ts +22 -0
- package/dist/bpmn/registry-fallback.js +206 -0
- package/dist/bpmn/typed-node.d.ts +13 -2
- package/dist/bpmn/typed-node.js +22 -5
- package/dist/check.js +195 -8
- package/dist/core/actions.d.ts +260 -51
- package/dist/core/actions.js +82 -35
- package/dist/core-definitions.json +1774 -1073
- package/dist/decompile.js +77 -13
- package/dist/index.d.ts +1 -1
- package/dist/index.js +4 -2
- package/dist/serialize.js +157 -24
- package/package.json +2 -2
package/dist/api-index.md
CHANGED
|
@@ -37,15 +37,15 @@ could hand you spans for a version you do not have.
|
|
|
37
37
|
|
|
38
38
|
## `@uipath/maestro-builder-sdk`
|
|
39
39
|
|
|
40
|
-
|
|
40
|
+
217 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:
|
|
44
|
+
| `ActionSpec` | type | `dist/core/actions.d.ts:2274-2375` | Supporting types | |
|
|
45
|
+
| `agent` | function | `dist/core/actions.d.ts:2980-3034` | Actions | Invoke an AGENT resource — either one published to Orchestrator or a sibling agent project registered in the same… |
|
|
46
46
|
| `AgentFlavour` | type | `dist/core/actions.d.ts:1140-1144` | Supporting types | Which KIND of agent project was published behind a `uipath.core.agent.<key>` resource. |
|
|
47
47
|
| `AgentGuardrail` | type | `dist/core/actions.d.ts:1368` | Supporting types | |
|
|
48
|
-
| `agenticProcess` | function | `dist/core/actions.d.ts:
|
|
48
|
+
| `agenticProcess` | function | `dist/core/actions.d.ts:2934-2979` | Actions | Invoke a deployed AGENTIC PROCESS — a Maestro process orchestration published to Orchestrator: a BPMN process that… |
|
|
49
49
|
| `AgenticProcessCompletion` | type | `dist/core/actions.d.ts:1099-1137` | Supporting types | Whether an Agentic Process step waits for the process's result. |
|
|
50
50
|
| `AgenticProcessInputs` | type | `dist/core/actions.d.ts:1138-1139` | Option shapes | What `agenticProcess()` takes: the shared fields plus the completion policy. |
|
|
51
51
|
| `AgenticProcessInputsBase` | interface | `dist/core/actions.d.ts:1064-1098` | Option shapes | 5 field(s) |
|
|
@@ -54,12 +54,12 @@ could hand you spans for a version you do not have.
|
|
|
54
54
|
| `AgentMemoryRef` | interface | `dist/core/actions.d.ts:1716-1740` | Supporting types | An episodic memory the agent learns from across runs, wired to the agent's own `memory` handle. |
|
|
55
55
|
| `Aggregation` | interface | `dist/core/actions.d.ts:246-252` | Supporting types | 3 field(s) |
|
|
56
56
|
| `AggregationOperation` | type | `dist/core/actions.d.ts:245` | Supporting types | |
|
|
57
|
-
| `apiWorkflow` | function | `dist/core/actions.d.ts:
|
|
57
|
+
| `apiWorkflow` | function | `dist/core/actions.d.ts:2748-2782` | Actions | Invoke a deployed API workflow — a coded workflow published to Orchestrator, run as a serverless job rather than by a… |
|
|
58
58
|
| `ApiWorkflowInputs` | interface | `dist/core/actions.d.ts:997-1028` | Option shapes | 5 field(s) |
|
|
59
59
|
| `AppRef` | interface | `dist/core/actions.d.ts:493-538` | 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:1092-1115` | Builders | The sub-builder an ARM callback receives — a `StepList` that can also name itself with `.label(...)`. |
|
|
61
61
|
| `AskedField` | interface | `dist/core/actions.d.ts:341-351` | Supporting types | A value the reviewer FILLS IN: read downstream with `out('<step>', '<id>')`. |
|
|
62
|
-
| `batchTransform` | function | `dist/core/actions.d.ts:
|
|
62
|
+
| `batchTransform` | function | `dist/core/actions.d.ts:2551-2585` | Actions | Add AI-generated columns to a CSV — the platform's **Batch transform** node, `uipath.pattern.batch-transform` (service… |
|
|
63
63
|
| `BatchTransformInputs` | interface | `dist/core/actions.d.ts:824-839` | Option shapes | 4 field(s) |
|
|
64
64
|
| `BindingContribution` | interface | `dist/core/node-classes.d.ts:76-97` | Supporting types | A resource binding a contribution hoists to the flow's top-level `bindings` array — the shape the `.flow` format… |
|
|
65
65
|
| `BuiltEntryPoint` | interface | `dist/flow-sdk.d.ts:621-633` | Supporting types | One additional flow root, built by `.entryPoint()`. |
|
|
@@ -70,8 +70,8 @@ could hand you spans for a version you do not have.
|
|
|
70
70
|
| `CaseValue` | type | `dist/flow-sdk.d.ts:287-288` | Supporting types | A value a `.switch` case compares the discriminant against. |
|
|
71
71
|
| `ChildFlow` | type | `dist/flow-sdk.d.ts:43-46` | Supporting types | Anything `subflow()` accepts as the child: a builder, or an already-built flow. |
|
|
72
72
|
| `ClientSideToolRef` | interface | `dist/core/actions.d.ts:1670-1685` | Supporting types | A CLIENT-side tool: the agent asks the CALLING application to run it and hand the answer back… |
|
|
73
|
-
| `connector` | function | `dist/core/actions.d.ts:
|
|
74
|
-
| `connector` | function | `dist/core/actions.d.ts:
|
|
73
|
+
| `connector` | function | `dist/core/actions.d.ts:3244-3267` | Actions | Declare an Integration Service connector action — the typed form, where a generated descriptor supplies the nodeType and… |
|
|
74
|
+
| `connector` | function | `dist/core/actions.d.ts:3268-3284` | Actions | Stringly form, for a connector with no prepared module — `connector('uipath-salesforce-slack',… |
|
|
75
75
|
| `ConnectorDescriptor` | type | `dist/core/connectors.d.ts:89-97` | Generated descriptors | A generated, typed connector descriptor: ConnectorMeta branded with phantom input/output types. |
|
|
76
76
|
| `ConnectorLookupValue` | type | `dist/core/connectors.d.ts:50-59` | Generated descriptors | ConnectorValue for a field that also accepts an unresolved lookup. |
|
|
77
77
|
| `ConnectorMeta` | interface | `dist/core/connectors.d.ts:60-88` | Generated descriptors | Runtime metadata a generated descriptor carries. |
|
|
@@ -81,41 +81,48 @@ could hand you spans for a version you do not have.
|
|
|
81
81
|
| `ContextIndexRef` | interface | `dist/core/actions.d.ts:1913-1947` | Supporting types | One Context Grounding index an inline agent is grounded on. |
|
|
82
82
|
| `ContributionContext` | interface | `dist/core/node-classes.d.ts:64-75` | Supporting types | What the serializer tells a contributor before asking for its contribution. |
|
|
83
83
|
| `ContributionDiagnostic` | interface | `dist/core/node-classes.d.ts:1-29` | Supporting types | Definition-backed node base classes — the public extension surface. |
|
|
84
|
-
| `conversationalAgent` | function | `dist/core/actions.d.ts:
|
|
84
|
+
| `conversationalAgent` | function | `dist/core/actions.d.ts:2909-2933` | Actions | A CONVERSATIONAL agent (`uipath.agent.conversational`) — it answers one turn of a live chat, reading the transcript… |
|
|
85
85
|
| `ConversationalAgentInputs` | interface | `dist/core/actions.d.ts:672-709` | Option shapes | 10 field(s) |
|
|
86
86
|
| `ConversationalAgentSettings` | interface | `dist/core/actions.d.ts:648-671` | Supporting types | How a conversational agent gets its turn — the node's own `conversationalAgentSettings` sub-object. |
|
|
87
|
-
| `conversationContext` | function | `dist/core/actions.d.ts:
|
|
87
|
+
| `conversationContext` | function | `dist/core/actions.d.ts:2844-2858` | Actions | READ a conversation's transcript so far without waiting (`uipath.conversational.get-conversation-context`) — the shape a… |
|
|
88
88
|
| `ConversationContextInputs` | interface | `dist/core/actions.d.ts:640-647` | Option shapes | 2 field(s) |
|
|
89
89
|
| `conversationTrigger` | function | `dist/flow-sdk.d.ts:235-261` | Flow construction | Start the flow when a new CONVERSATION is created (`core.trigger.conversation`) — the entry point for a chat-driven… |
|
|
90
|
-
| `createOutgoingCall` | function | `dist/core/actions.d.ts:
|
|
90
|
+
| `createOutgoingCall` | function | `dist/core/actions.d.ts:2859-2875` | Actions | Place an outgoing phone call (`uipath.conversational.voice.create-outgoing-call`) and get back the `callContext` every… |
|
|
91
91
|
| `CreateOutgoingCallInputs` | interface | `dist/core/actions.d.ts:710-718` | Option shapes | 2 field(s) |
|
|
92
92
|
| `CustomGuardrail` | interface | `dist/core/actions.d.ts:1313-1325` | Supporting types | A rule-based guardrail you author in place. |
|
|
93
|
-
| `
|
|
94
|
-
| `
|
|
95
|
-
| `
|
|
96
|
-
| `
|
|
97
|
-
| `
|
|
93
|
+
| `dataFabricCreate` | function | `dist/core/actions.d.ts:3146-3163` | Actions | Create an entity record in Data Fabric (`core.datafabric.create`). |
|
|
94
|
+
| `DataFabricCreateInputs` | interface | `dist/core/actions.d.ts:2139-2169` | Option shapes | 4 field(s) |
|
|
95
|
+
| `dataFabricDelete` | function | `dist/core/actions.d.ts:3180-3197` | Actions | Delete an entity record from Data Fabric (`core.datafabric.delete`). |
|
|
96
|
+
| `DataFabricDeleteInputs` | interface | `dist/core/actions.d.ts:2202-2228` | Option shapes | 4 field(s) |
|
|
97
|
+
| `DataFabricFilter` | interface | `dist/core/actions.d.ts:2030-2061` | Supporting types | One filter row on a Data Fabric query — rows AND together unless `or` is set. |
|
|
98
|
+
| `DataFabricOperator` | type | `dist/core/actions.d.ts:2019-2029` | Supporting types | The comparison operators the Data Fabric query serializer can emit, spelled exactly as the file carries them. |
|
|
99
|
+
| `dataFabricRead` | function | `dist/core/actions.d.ts:3106-3145` | Actions | Query entity records from Data Fabric (`core.datafabric.read`). |
|
|
100
|
+
| `DataFabricReadInputs` | interface | `dist/core/actions.d.ts:2086-2138` | Option shapes | 9 field(s) |
|
|
101
|
+
| `DataFabricRecordRef` | type | `dist/core/actions.d.ts:2069-2085` | Supporting types | Which record a Data Fabric write targets — exactly ONE of the two forms. |
|
|
102
|
+
| `DataFabricSort` | interface | `dist/core/actions.d.ts:2062-2068` | Supporting types | How a multi-record query orders its rows before the limit is applied. |
|
|
103
|
+
| `dataFabricUpdate` | function | `dist/core/actions.d.ts:3164-3179` | Actions | Update an entity record in Data Fabric (`core.datafabric.update`). |
|
|
104
|
+
| `DataFabricUpdateInputs` | interface | `dist/core/actions.d.ts:2170-2201` | Option shapes | 5 field(s) |
|
|
98
105
|
| `DEFAULT_TRIGGER_ID` | const | `dist/core/expr.d.ts:36-37` | Expressions and types | The manual trigger node's default id. |
|
|
99
106
|
| `DefinitionReference` | type | `dist/core/node-classes.d.ts:30-63` | Supporting types | An exact reference to the node definition a contribution compiles against. |
|
|
100
|
-
| `delay` | function | `dist/core/actions.d.ts:
|
|
107
|
+
| `delay` | function | `dist/core/actions.d.ts:2641-2662` | Actions | Declare a delay — a step that pauses the flow for a fixed length of time and then carries on. |
|
|
101
108
|
| `DELAY_PRESETS` | const | `dist/core/actions.d.ts:932-939` | Actions | The twelve durations the designer's dropdown offers. |
|
|
102
109
|
| `DelayInputs` | type | `dist/core/actions.d.ts:940-961` | Option shapes | |
|
|
103
110
|
| `descriptor` | function | `dist/core/connectors.d.ts:98-110` | Generated descriptors | Brand a descriptor literal with its input/output types (zero runtime cost). |
|
|
104
|
-
| `documentClassify` | function | `dist/core/actions.d.ts:
|
|
105
|
-
| `DocumentClassifyInputs` | interface | `dist/core/actions.d.ts:
|
|
111
|
+
| `documentClassify` | function | `dist/core/actions.d.ts:3086-3094` | Actions | Classify a document into a document type (`uipath.document.classify`). |
|
|
112
|
+
| `DocumentClassifyInputs` | interface | `dist/core/actions.d.ts:2229-2238` | Option shapes | 4 field(s) |
|
|
106
113
|
| `DocValidationInputs` | interface | `dist/core/actions.d.ts:431-454` | Option shapes | The Document Validation task's subject — `variant: 'document-validation'` only. |
|
|
107
114
|
| `DoWhileOptions` | interface | `dist/flow-sdk.d.ts:408-417` | Option shapes | Do-while options. |
|
|
108
|
-
| `dynamicExtract` | function | `dist/core/actions.d.ts:
|
|
109
|
-
| `DynamicExtractInputs` | interface | `dist/core/actions.d.ts:
|
|
115
|
+
| `dynamicExtract` | function | `dist/core/actions.d.ts:3095-3105` | Actions | Extract fields from a document with an INLINE schema — Dynamic Extract (`uipath.ixp.extract-document-builder`), the… |
|
|
116
|
+
| `DynamicExtractInputs` | interface | `dist/core/actions.d.ts:2239-2273` | Option shapes | 5 field(s) |
|
|
110
117
|
| `EdgeRoute` | interface | `dist/flow-sdk.d.ts:545-559` | Supporting types | One edge's route: user-dragged bends and/or the auto-router's waypoints. |
|
|
111
|
-
| `endCall` | function | `dist/core/actions.d.ts:
|
|
118
|
+
| `endCall` | function | `dist/core/actions.d.ts:2876-2883` | Actions | Hang up (`uipath.conversational.voice.end-call`). |
|
|
112
119
|
| `EndCallInputs` | interface | `dist/core/actions.d.ts:719-726` | Option shapes | 1 field(s) |
|
|
113
120
|
| `entryInput` | function | `dist/core/expr.d.ts:56-66` | Expressions and types | Reference an ENTRY POINT's scoped input: `entryInput('nightly', 'batchDate')` reads `$vars.nightly.output.batchDate` —… |
|
|
114
121
|
| `err` | function | `dist/core/expr.d.ts:148-235` | Expressions and types | Reference a FAILED step's error → `$vars.<step>.error[.<field>]`. |
|
|
115
122
|
| `ErrorEnvelopeField` | type | `dist/core/expr.d.ts:137-147` | Supporting types | The fields a failure envelope carries. |
|
|
116
123
|
| `EscalationRef` | interface | `dist/core/actions.d.ts:1858-1912` | Supporting types | One escalation an inline agent may raise — an Action Center app task a human completes (the `coded-action-app` variant,… |
|
|
117
|
-
| `EventFilter` | type | `dist/core/actions.d.ts:
|
|
118
|
-
| `EventSubscription` | interface | `dist/core/actions.d.ts:
|
|
124
|
+
| `EventFilter` | type | `dist/core/actions.d.ts:3285-3326` | Supporting types | One filter condition on the event payload. |
|
|
125
|
+
| `EventSubscription` | interface | `dist/core/actions.d.ts:3372-3410` | Option shapes | What a connector event subscribes to. |
|
|
119
126
|
| `Expr` | class | `dist/core/expr.d.ts:11-21` | Supporting types | A Flow expression. |
|
|
120
127
|
| `FieldMapping` | interface | `dist/core/actions.d.ts:237-244` | Supporting types | 3 field(s) |
|
|
121
128
|
| `FilterCondition` | type | `dist/core/actions.d.ts:220-221` | Supporting types | Comparison a filter rule applies to a field. |
|
|
@@ -138,25 +145,25 @@ could hand you spans for a version you do not have.
|
|
|
138
145
|
| `GuardrailRule` | type | `dist/core/actions.d.ts:1282-1301` | Supporting types | One condition of a custom guardrail. |
|
|
139
146
|
| `GuardrailScope` | type | `dist/core/actions.d.ts:1261-1262` | Supporting types | Where a guardrail applies: the whole agent, its LLM calls, or its tools. |
|
|
140
147
|
| `GuardrailSelector` | interface | `dist/core/actions.d.ts:1263-1268` | Supporting types | Which artifacts inside the scope the guardrail watches. |
|
|
141
|
-
| `hitl` | function | `dist/core/actions.d.ts:
|
|
148
|
+
| `hitl` | function | `dist/core/actions.d.ts:2458-2509` | 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… |
|
|
142
149
|
| `HitlAssigneeType` | type | `dist/core/actions.d.ts:377-384` | Supporting types | How the task is assigned, the platform's own vocabulary (canvas `HITL_ASSIGNEE_TYPE`): `'user'` a single user, `'group'`… |
|
|
143
150
|
| `HitlChannel` | type | `dist/core/actions.d.ts:371-376` | Supporting types | Where the task is delivered. |
|
|
144
151
|
| `HitlConnection` | interface | `dist/core/actions.d.ts:385-393` | Supporting types | A per-channel Integration Service connection (Slack / Teams delivery). |
|
|
145
152
|
| `HitlInputs` | interface | `dist/core/actions.d.ts:539-610` | Option shapes | 11 field(s) |
|
|
146
153
|
| `HitlRecipient` | interface | `dist/core/actions.d.ts:394-430` | Supporting types | Who gets the task and over which channels. |
|
|
147
154
|
| `HitlVariant` | type | `dist/core/actions.d.ts:467-492` | Supporting types | WHICH human-task node type to emit. |
|
|
148
|
-
| `http` | function | `dist/core/actions.d.ts:
|
|
155
|
+
| `http` | function | `dist/core/actions.d.ts:2396-2403` | Actions | Declare an HTTP request action, explicitly choosing standalone or managed. |
|
|
149
156
|
| `HttpBranch` | interface | `dist/core/actions.d.ts:14-29` | Supporting types | One conditional response branch on an HTTP node — a designer-visible side exit. |
|
|
150
157
|
| `HttpInputs` | type | `dist/core/actions.d.ts:121-138` | Option shapes | |
|
|
151
158
|
| `HttpInputsBase` | interface | `dist/core/actions.d.ts:30-120` | Option shapes | 11 field(s) |
|
|
152
159
|
| `HttpRequestToolRef` | interface | `dist/core/actions.d.ts:1686-1715` | Supporting types | The built-in HTTP-request tool (`uipath.agent.resource.tool.builtin.httprequest`): the agent performs an HTTP call. |
|
|
153
|
-
| `inlineAgent` | function | `dist/core/actions.d.ts:
|
|
160
|
+
| `inlineAgent` | function | `dist/core/actions.d.ts:3035-3085` | Actions | Declare an INLINE AUTONOMOUS AGENT — an agent defined inside this flow's own project rather than published to… |
|
|
154
161
|
| `InlineAgentFieldType` | type | `dist/core/actions.d.ts:1241-1242` | Supporting types | A JSON-schema-ish type for one field of an inline agent's input/output schema. |
|
|
155
162
|
| `InlineAgentInputs` | interface | `dist/core/actions.d.ts:1369-1607` | Option shapes | 16 field(s) |
|
|
156
163
|
| `InOutField` | interface | `dist/core/actions.d.ts:352-369` | Supporting types | A value the reviewer READS **and can correct**: pre-filled from the flow, editable on the form, and the (possibly… |
|
|
157
164
|
| `input` | function | `dist/core/expr.d.ts:38-55` | Expressions and types | Reference a flow input by name → `$vars.<triggerId>.output.<name>`. |
|
|
158
165
|
| `isLookupToken` | function | `dist/core/lookups.d.ts:53-54` | Generated descriptors | True when `v` is an unresolved LookupToken. |
|
|
159
|
-
| `ixpExtract` | function | `dist/core/actions.d.ts:
|
|
166
|
+
| `ixpExtract` | function | `dist/core/actions.d.ts:2586-2640` | Actions | Extract fields from a document with a published IxP project — the platform's **Extract** node (`uipath.ixp.*`, service… |
|
|
160
167
|
| `IxpExtractInputs` | interface | `dist/core/actions.d.ts:857-931` | Option shapes | 9 field(s) |
|
|
161
168
|
| `IxpToolRef` | interface | `dist/core/actions.d.ts:1819-1857` | Supporting types | A published IxP (Intelligent eXtraction Platform) project as a tool — the agent decides when to extract a document and… |
|
|
162
169
|
| `js` | function | `dist/core/expr.d.ts:236-247` | Expressions and types | Build a raw JS *expression* (a condition or computation). |
|
|
@@ -176,7 +183,7 @@ could hand you spans for a version you do not have.
|
|
|
176
183
|
| `LoopOptions` | interface | `dist/flow-sdk.d.ts:386-407` | Option shapes | Loop-specific options. |
|
|
177
184
|
| `manual` | function | `dist/flow-sdk.d.ts:130-139` | Flow construction | The manual trigger, explicitly. |
|
|
178
185
|
| `McpToolRef` | interface | `dist/core/actions.d.ts:1620-1648` | Supporting types | An MCP server the agent may call tools on. |
|
|
179
|
-
| `mock` | function | `dist/core/actions.d.ts:
|
|
186
|
+
| `mock` | function | `dist/core/actions.d.ts:2663-2702` | Actions | Declare a PLACEHOLDER step — "a real node goes here later". |
|
|
180
187
|
| `NodeContribution` | interface | `dist/core/node-classes.d.ts:98-121` | Supporting types | One validated construct, returned by FlowNode.contribute. |
|
|
181
188
|
| `NodeLayout` | interface | `dist/flow-sdk.d.ts:530-544` | Supporting types | One node's designer layout: canvas position, and optionally size and collapsed state. |
|
|
182
189
|
| `NodeOptions` | interface | `dist/flow-sdk.d.ts:308-353` | Option shapes | Options shared by every builder method that creates a definition-backed node: `version` selects the exact node… |
|
|
@@ -188,9 +195,9 @@ could hand you spans for a version you do not have.
|
|
|
188
195
|
| `PortArm` | interface | `dist/flow-sdk.d.ts:295-307` | Supporting types | One arm of a built `.stepSwitch` — the same shape as SwitchArm, but `value` names an exit the ACTION declares (a… |
|
|
189
196
|
| `ProcessToolKind` | type | `dist/core/actions.d.ts:1781-1794` | Supporting types | The tool kinds that wrap a DEPLOYED tenant resource. |
|
|
190
197
|
| `ProcessToolRef` | interface | `dist/core/actions.d.ts:1795-1818` | Supporting types | A deployed tenant resource the agent may invoke. |
|
|
191
|
-
| `publishedFunction` | function | `dist/core/actions.d.ts:
|
|
198
|
+
| `publishedFunction` | function | `dist/core/actions.d.ts:2783-2807` | Actions | Invoke a published Orchestrator **Function** — a deployed unit of code run as one step (`uipath.core.function.<key>`,… |
|
|
192
199
|
| `PublishedFunctionInputs` | interface | `dist/core/actions.d.ts:1029-1063` | Option shapes | A published Orchestrator **Function** — a small, single-purpose unit of code deployed as its own resource and invoked as… |
|
|
193
|
-
| `queueItem` | function | `dist/core/actions.d.ts:
|
|
200
|
+
| `queueItem` | function | `dist/core/actions.d.ts:3198-3243` | Actions | Declare an Orchestrator QUEUE ITEM step. |
|
|
194
201
|
| `QueueItemInputs` | interface | `dist/core/actions.d.ts:1950-2018` | Option shapes | 10 field(s) |
|
|
195
202
|
| `QueuePriority` | type | `dist/core/actions.d.ts:1948-1949` | Supporting types | The three priorities an Orchestrator queue item can carry. |
|
|
196
203
|
| `ran` | function | `dist/core/expr.d.ts:90-136` | Expressions and types | Did this step run? |
|
|
@@ -201,18 +208,18 @@ could hand you spans for a version you do not have.
|
|
|
201
208
|
| `resolvedValue` | function | `dist/core/lookups.d.ts:172-179` | Generated descriptors | The recorded id for a token, or `undefined`. |
|
|
202
209
|
| `ReturnFieldType` | type | `dist/core/actions.d.ts:1243-1260` | Supporting types | A JSON-schema-ish type for one field of a step's declared `returns`. |
|
|
203
210
|
| `ReturnOptions` | interface | `dist/flow-sdk.d.ts:354-385` | Option shapes | `.return(...)`-specific options. |
|
|
204
|
-
| `rpaWorkflow` | function | `dist/core/actions.d.ts:
|
|
211
|
+
| `rpaWorkflow` | function | `dist/core/actions.d.ts:2703-2747` | Actions | Invoke a deployed RPA (robotic process automation) workflow — a classic UI-automation process, published to… |
|
|
205
212
|
| `RpaWorkflowInputs` | interface | `dist/core/actions.d.ts:962-996` | Option shapes | 5 field(s) |
|
|
206
213
|
| `SCHEDULE_PRESETS` | const | `dist/flow-sdk.d.ts:77-84` | Flow construction | The eight intervals the designer offers in its Frequency dropdown. |
|
|
207
214
|
| `scheduled` | function | `dist/flow-sdk.d.ts:186-205` | Flow construction | Start the flow on a recurring schedule instead of on demand. |
|
|
208
215
|
| `ScheduledInputs` | interface | `dist/flow-sdk.d.ts:98-110` | Option shapes | 1 field(s) |
|
|
209
216
|
| `ScheduleEvery` | type | `dist/flow-sdk.d.ts:86-97` | Supporting types | How often a scheduled flow runs, as an ISO-8601 repeating interval: `R/` followed by a duration. |
|
|
210
217
|
| `SchedulePreset` | type | `dist/flow-sdk.d.ts:85` | Supporting types | |
|
|
211
|
-
| `script` | function | `dist/core/actions.d.ts:
|
|
218
|
+
| `script` | function | `dist/core/actions.d.ts:2404-2411` | Actions | Declare an inline script action. |
|
|
212
219
|
| `ScriptInputs` | interface | `dist/core/actions.d.ts:139-176` | Option shapes | 2 field(s) |
|
|
213
220
|
| `ScriptReturns` | type | `dist/core/script-return.d.ts:33-38` | Supporting types | What an author may write for `script({ returns })`: the type outright, or — for an object return — the FIELDS, which is… |
|
|
214
221
|
| `ScriptReturnType` | type | `dist/core/script-return.d.ts:31-32` | Supporting types | The vocabulary a script's output can be declared as. |
|
|
215
|
-
| `sendMessage` | function | `dist/core/actions.d.ts:
|
|
222
|
+
| `sendMessage` | function | `dist/core/actions.d.ts:2808-2826` | Actions | Post an assistant message into a live conversation (`uipath.conversational.send-message`). |
|
|
216
223
|
| `SendMessageInputs` | interface | `dist/core/actions.d.ts:611-630` | Option shapes | 4 field(s) |
|
|
217
224
|
| `ShownField` | interface | `dist/core/actions.d.ts:325-340` | Supporting types | A value the reviewer READS: shown on the form, filled in from the flow. |
|
|
218
225
|
| `Step` | type | `dist/flow-sdk.d.ts:418-529` | Supporting types | |
|
|
@@ -222,12 +229,12 @@ could hand you spans for a version you do not have.
|
|
|
222
229
|
| `StickyNoteColor` | type | `dist/flow-sdk.d.ts:566-571` | Supporting types | A sticky note's swatch. |
|
|
223
230
|
| `subflow` | function | `dist/flow-sdk.d.ts:1363-1402` | Flow construction | Run another flow as one step, and read back what it returns. |
|
|
224
231
|
| `SubflowSpec` | interface | `dist/flow-sdk.d.ts:33-40` | Supporting types | A step that runs a child flow. |
|
|
225
|
-
| `summarize` | function | `dist/core/actions.d.ts:
|
|
232
|
+
| `summarize` | function | `dist/core/actions.d.ts:2510-2550` | Actions | Summarize a document with citations — the platform's **Summarize** node. |
|
|
226
233
|
| `SummarizeInputs` | interface | `dist/core/actions.d.ts:784-816` | Option shapes | 3 field(s) |
|
|
227
234
|
| `SwitchArm` | interface | `dist/flow-sdk.d.ts:289-294` | Supporting types | One arm of a built `.switch` (the serializer's view: body already collected). |
|
|
228
235
|
| `tmpl` | function | `dist/core/expr.d.ts:248-258` | Expressions and types | Build a JS *string template* (for URLs, messages, etc.). |
|
|
229
236
|
| `ToolRef` | type | `dist/core/actions.d.ts:1610-1619` | Supporting types | One tool on an inline agent — a discriminated union over the kinds the tenant's registry actually serves… |
|
|
230
|
-
| `transform` | function | `dist/core/actions.d.ts:
|
|
237
|
+
| `transform` | function | `dist/core/actions.d.ts:2412-2457` | Actions | Declare a Transform action — a chain of declarative operations over a collection. |
|
|
231
238
|
| `Transformation` | type | `dist/core/actions.d.ts:235-236` | Supporting types | What a map does to a field's value. |
|
|
232
239
|
| `TransformInputs` | interface | `dist/core/actions.d.ts:294-318` | Option shapes | 3 field(s) |
|
|
233
240
|
| `TransformOperation` | type | `dist/core/actions.d.ts:253-270` | Supporting types | One link in the chain. |
|
|
@@ -235,7 +242,7 @@ could hand you spans for a version you do not have.
|
|
|
235
242
|
| `triggerDescriptor` | function | `dist/core/connectors.d.ts:139-151` | Generated descriptors | Brand a trigger descriptor literal with its where/output types. |
|
|
236
243
|
| `TriggerDescriptor` | type | `dist/core/connectors.d.ts:130-138` | Generated descriptors | A generated, typed connector-trigger descriptor: TriggerMeta branded with phantom `where`/output types. |
|
|
237
244
|
| `TriggerMeta` | interface | `dist/core/connectors.d.ts:120-129` | Generated descriptors | Runtime metadata a generated trigger descriptor carries. |
|
|
238
|
-
| `TriggerOptions` | interface | `dist/core/actions.d.ts:
|
|
245
|
+
| `TriggerOptions` | interface | `dist/core/actions.d.ts:3327-3371` | Option shapes | The typed `onEvent`/`waitForEvent` options — everything an EventSubscription carries except `connector`/`event`, which… |
|
|
239
246
|
| `TriggerSpec` | type | `dist/flow-sdk.d.ts:111-129` | Supporting types | What starts the flow. |
|
|
240
247
|
| `TypeDesc` | type | `dist/core/expr.d.ts:323` | Supporting types | |
|
|
241
248
|
| `types` | const | `dist/core/expr.d.ts:307-322` | Expressions and types | Variable type descriptors (map to Flow variable `type` values). |
|
|
@@ -243,13 +250,13 @@ could hand you spans for a version you do not have.
|
|
|
243
250
|
| `v` | function | `dist/core/expr.d.ts:29-35` | Expressions and types | Reference a flow-level variable or input by name → `$vars.<name>`. |
|
|
244
251
|
| `VarDecl` | interface | `dist/flow-sdk.d.ts:47-57` | Supporting types | 6 field(s) |
|
|
245
252
|
| `VarSpec` | interface | `dist/flow-sdk.d.ts:58-76` | Supporting types | The rich spelling of a variable declaration: pass it instead of a bare `types.*` descriptor wherever `.input()` /… |
|
|
246
|
-
| `voiceAgent` | function | `dist/core/actions.d.ts:
|
|
253
|
+
| `voiceAgent` | function | `dist/core/actions.d.ts:2884-2908` | Actions | Put a VOICE agent on a live call (`uipath.agent.voice`) — it speaks and listens for one turn, then the flow continues. |
|
|
247
254
|
| `VoiceAgentInputs` | interface | `dist/core/actions.d.ts:750-783` | Option shapes | 6 field(s) |
|
|
248
255
|
| `VoiceSettings` | interface | `dist/core/actions.d.ts:727-749` | Supporting types | The audio settings a voice agent speaks with. |
|
|
249
256
|
| `voiceTrigger` | function | `dist/flow-sdk.d.ts:262-286` | Flow construction | Start the flow when a phone call comes IN (`core.trigger.voice`). |
|
|
250
|
-
| `waitForEvent` | function | `dist/core/actions.d.ts:
|
|
251
|
-
| `waitForEvent` | function | `dist/core/actions.d.ts:
|
|
252
|
-
| `waitForMessage` | function | `dist/core/actions.d.ts:
|
|
257
|
+
| `waitForEvent` | function | `dist/core/actions.d.ts:3420-3454` | Actions | Wait mid-flow until a connector event fires, then continue with its payload — the typed form, where a generated trigger… |
|
|
258
|
+
| `waitForEvent` | function | `dist/core/actions.d.ts:3455-3462` | Actions | Stringly form, for an event with no prepared module. |
|
|
259
|
+
| `waitForMessage` | function | `dist/core/actions.d.ts:2827-2843` | Actions | PAUSE until the person sends their next message (`uipath.conversational.wait-for-message`) — a catch event, like… |
|
|
253
260
|
| `WaitForMessageInputs` | interface | `dist/core/actions.d.ts:631-639` | Option shapes | 2 field(s) |
|
|
254
261
|
|
|
255
262
|
## `@uipath/maestro-builder-sdk/case`
|
|
@@ -292,8 +299,8 @@ could hand you spans for a version you do not have.
|
|
|
292
299
|
| `EscalationOpts` | interface | `dist/case/case-sdk.d.ts:127-139` | Option shapes | 4 field(s) |
|
|
293
300
|
| `EscalationRecipient` | interface | `dist/case/case-sdk.d.ts:119-126` | Supporting types | Who an escalation notifies. |
|
|
294
301
|
| `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`). |
|
|
295
|
-
| `EventFilter` | type | `dist/core/actions.d.ts:
|
|
296
|
-
| `EventSubscription` | interface | `dist/core/actions.d.ts:
|
|
302
|
+
| `EventFilter` | type | `dist/core/actions.d.ts:3285-3326` | Supporting types | One filter condition on the event payload. |
|
|
303
|
+
| `EventSubscription` | interface | `dist/core/actions.d.ts:3372-3410` | Option shapes | What a connector event subscribes to. |
|
|
297
304
|
| `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. |
|
|
298
305
|
| `eventTrigger` | function | `dist/case/case-sdk.d.ts:287-293` | Case authoring | An Integration Service event trigger in placeholder or stringly-resolved form. |
|
|
299
306
|
| `EventTriggerOpts` | interface | `dist/case/case-sdk.d.ts:239-263` | Option shapes | 4 field(s) |
|
|
@@ -329,7 +336,7 @@ could hand you spans for a version you do not have.
|
|
|
329
336
|
| `toUser` | function | `dist/case/case-sdk.d.ts:150-157` | Case authoring | An escalation recipient that is a single user. |
|
|
330
337
|
| `TriggerDescriptor` | type | `dist/core/connectors.d.ts:130-138` | Supporting types | A generated, typed connector-trigger descriptor: TriggerMeta branded with phantom `where`/output types. |
|
|
331
338
|
| `TriggerMeta` | interface | `dist/core/connectors.d.ts:120-129` | Supporting types | Runtime metadata a generated trigger descriptor carries. |
|
|
332
|
-
| `TriggerOptions` | interface | `dist/core/actions.d.ts:
|
|
339
|
+
| `TriggerOptions` | interface | `dist/core/actions.d.ts:3327-3371` | Option shapes | The typed `onEvent`/`waitForEvent` options — everything an EventSubscription carries except `connector`/`event`, which… |
|
|
333
340
|
| `TypeDesc` | type | `dist/core/expr.d.ts:323` | Supporting types | |
|
|
334
341
|
| `UnresolvedReferenceTaskKind` | type | `dist/case/case-sdk.d.ts:358-359` | Supporting types | Published-resource task kinds that the Case schema permits as unresolved skeletons. |
|
|
335
342
|
| `WaitConnectorPlaceholderSpec` | interface | `dist/case/case-sdk.d.ts:360-370` | Supporting types | A `wait-for-connector` subscription: suspend on an Integration Service event. |
|
|
@@ -399,8 +406,8 @@ could hand you spans for a version you do not have.
|
|
|
399
406
|
| `ThrowOpts` | interface | `dist/bpmn/bpmn-sdk.d.ts:616-624` | Option shapes | Options for `.intermediateThrowEvent()` — a `message` to throw, or none. |
|
|
400
407
|
| `TimerLike` | type | `dist/bpmn/bpmn-sdk.d.ts:37-38` | Supporting types | A timer as an ISO-8601 duration string (shorthand for `{ duration }`) or a full spec. |
|
|
401
408
|
| `TimerSpec` | interface | `dist/bpmn/bpmn-sdk.d.ts:28-36` | Supporting types | ISO-8601 timer specification (one of duration / date / cycle). |
|
|
402
|
-
| `TypedContextRow` | interface | `dist/bpmn/typed-node.d.ts:
|
|
409
|
+
| `TypedContextRow` | interface | `dist/bpmn/typed-node.d.ts:152-183` | Supporting types | One `uipath:context` input row, spelled out. |
|
|
403
410
|
| `TypeDesc` | type | `dist/core/expr.d.ts:323` | Supporting types | |
|
|
404
|
-
| `TypedOutputRow` | interface | `dist/bpmn/typed-node.d.ts:
|
|
411
|
+
| `TypedOutputRow` | interface | `dist/bpmn/typed-node.d.ts:184-208` | Supporting types | 8 field(s) |
|
|
405
412
|
| `VarDirection` | type | `dist/bpmn/bpmn-sdk.d.ts:330-334` | Supporting types | How a variable is exposed: `'input'` (read-only entry input), `'output'` (a return value), or `'inputOutput'` (a mutable… |
|
|
406
413
|
| `VarOpts` | interface | `dist/bpmn/bpmn-sdk.d.ts:1231-1255` | Option shapes | Options for `.var()` / `.input()` / `.output()`. |
|