@uipath/maestro-builder-sdk 6.16.3 → 6.16.4
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 +68 -68
- package/dist/api-members.md +165 -165
- package/dist/core/actions.d.ts +11 -12
- package/dist/decompile-cli.js +10 -1
- package/dist/decompile.d.ts +11 -0
- package/dist/decompile.js +49 -1
- package/dist/serialize.js +25 -53
- package/package.json +2 -2
package/dist/api-index.md
CHANGED
|
@@ -41,88 +41,88 @@ could hand you spans for a version you do not have.
|
|
|
41
41
|
|
|
42
42
|
| Symbol | Kind | Declaration | Area | Summary |
|
|
43
43
|
| --- | --- | --- | --- | --- |
|
|
44
|
-
| `ActionSpec` | type | `dist/core/actions.d.ts:
|
|
45
|
-
| `agent` | function | `dist/core/actions.d.ts:
|
|
44
|
+
| `ActionSpec` | type | `dist/core/actions.d.ts:2343-2444` | Supporting types | |
|
|
45
|
+
| `agent` | function | `dist/core/actions.d.ts:3049-3103` | 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:1156-1160` | 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:1384` | Supporting types | |
|
|
48
|
-
| `agenticProcess` | function | `dist/core/actions.d.ts:
|
|
48
|
+
| `agenticProcess` | function | `dist/core/actions.d.ts:3003-3048` | 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:1115-1153` | Supporting types | Whether an Agentic Process step waits for the process's result. |
|
|
50
50
|
| `AgenticProcessInputs` | type | `dist/core/actions.d.ts:1154-1155` | Option shapes | What `agenticProcess()` takes: the shared fields plus the completion policy. |
|
|
51
51
|
| `AgenticProcessInputsBase` | interface | `dist/core/actions.d.ts:1080-1114` | Option shapes | 5 field(s) |
|
|
52
52
|
| `AgentInputs` | interface | `dist/core/actions.d.ts:1162-1256` | Option shapes | 8 field(s) |
|
|
53
53
|
| `AgentLocation` | type | `dist/core/actions.d.ts:1161` | Supporting types | |
|
|
54
|
-
| `AgentMemoryRef` | interface | `dist/core/actions.d.ts:
|
|
54
|
+
| `AgentMemoryRef` | interface | `dist/core/actions.d.ts:1748-1772` | 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:259-265` | Supporting types | 3 field(s) |
|
|
56
56
|
| `AggregationOperation` | type | `dist/core/actions.d.ts:258` | Supporting types | |
|
|
57
|
-
| `apiWorkflow` | function | `dist/core/actions.d.ts:
|
|
57
|
+
| `apiWorkflow` | function | `dist/core/actions.d.ts:2817-2851` | 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:1013-1044` | Option shapes | 5 field(s) |
|
|
59
59
|
| `AppRef` | interface | `dist/core/actions.d.ts:506-551` | 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:1132-1155` | 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:354-364` | 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:2620-2654` | 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:837-852` | 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:660-672` | Supporting types | One additional flow root, built by `.entryPoint()`. |
|
|
66
66
|
| `BuiltFlow` | interface | `dist/flow-sdk.d.ts:673-708` | Supporting types | 15 field(s) |
|
|
67
|
-
| `BuiltinToolName` | type | `dist/core/actions.d.ts:1641
|
|
68
|
-
| `BuiltinToolRef` | interface | `dist/core/actions.d.ts:
|
|
67
|
+
| `BuiltinToolName` | type | `dist/core/actions.d.ts:1640-1641` | Supporting types | The three platform-shipped built-in tools (fixed registry types). |
|
|
68
|
+
| `BuiltinToolRef` | interface | `dist/core/actions.d.ts:1773-1793` | Supporting types | A platform built-in tool. |
|
|
69
69
|
| `BuiltInValidatorGuardrail` | interface | `dist/core/actions.d.ts:1342-1383` | Supporting types | A platform-shipped validator, configured by parameters. |
|
|
70
70
|
| `CaseValue` | type | `dist/flow-sdk.d.ts:327-328` | 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
|
-
| `ClientSideToolRef` | interface | `dist/core/actions.d.ts:
|
|
73
|
-
| `connector` | function | `dist/core/actions.d.ts:
|
|
74
|
-
| `connector` | function | `dist/core/actions.d.ts:
|
|
72
|
+
| `ClientSideToolRef` | interface | `dist/core/actions.d.ts:1702-1717` | 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:3312-3335` | 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:3336-3352` | 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. |
|
|
78
78
|
| `ConnectorOpts` | interface | `dist/core/actions.d.ts:187-230` | Option shapes | 4 field(s) |
|
|
79
|
-
| `ConnectorToolRef` | interface | `dist/core/actions.d.ts:
|
|
79
|
+
| `ConnectorToolRef` | interface | `dist/core/actions.d.ts:1794-1831` | Supporting types | An Integration Service connector operation as a tool — e.g. "create a Jira issue". |
|
|
80
80
|
| `ConnectorValue` | type | `dist/core/connectors.d.ts:26-49` | Generated descriptors | What a generated `Inputs` property accepts: the value, or an expression. |
|
|
81
|
-
| `ContextIndexRef` | interface | `dist/core/actions.d.ts:
|
|
81
|
+
| `ContextIndexRef` | interface | `dist/core/actions.d.ts:1977-2011` | 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:2978-3002` | 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:685-722` | Option shapes | 10 field(s) |
|
|
86
86
|
| `ConversationalAgentSettings` | interface | `dist/core/actions.d.ts:661-684` | 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:2913-2927` | 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:653-660` | Option shapes | 2 field(s) |
|
|
89
89
|
| `conversationTrigger` | function | `dist/flow-sdk.d.ts:275-301` | 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:2928-2944` | 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:723-731` | Option shapes | 2 field(s) |
|
|
92
92
|
| `CustomGuardrail` | interface | `dist/core/actions.d.ts:1329-1341` | Supporting types | A rule-based guardrail you author in place. |
|
|
93
|
-
| `dataFabricCreate` | function | `dist/core/actions.d.ts:
|
|
94
|
-
| `DataFabricCreateInputs` | interface | `dist/core/actions.d.ts:
|
|
95
|
-
| `dataFabricDelete` | function | `dist/core/actions.d.ts:
|
|
96
|
-
| `DataFabricDeleteInputs` | interface | `dist/core/actions.d.ts:
|
|
97
|
-
| `DataFabricFilter` | interface | `dist/core/actions.d.ts:
|
|
98
|
-
| `DataFabricOperator` | type | `dist/core/actions.d.ts:
|
|
99
|
-
| `dataFabricRead` | function | `dist/core/actions.d.ts:
|
|
100
|
-
| `DataFabricReadInputs` | interface | `dist/core/actions.d.ts:
|
|
101
|
-
| `DataFabricRecordRef` | type | `dist/core/actions.d.ts:
|
|
102
|
-
| `DataFabricSort` | interface | `dist/core/actions.d.ts:
|
|
103
|
-
| `dataFabricUpdate` | function | `dist/core/actions.d.ts:
|
|
104
|
-
| `DataFabricUpdateInputs` | interface | `dist/core/actions.d.ts:
|
|
93
|
+
| `dataFabricCreate` | function | `dist/core/actions.d.ts:3214-3231` | Actions | Create an entity record in Data Fabric (`core.datafabric.create`). |
|
|
94
|
+
| `DataFabricCreateInputs` | interface | `dist/core/actions.d.ts:2208-2238` | Option shapes | 4 field(s) |
|
|
95
|
+
| `dataFabricDelete` | function | `dist/core/actions.d.ts:3248-3265` | Actions | Delete an entity record from Data Fabric (`core.datafabric.delete`). |
|
|
96
|
+
| `DataFabricDeleteInputs` | interface | `dist/core/actions.d.ts:2271-2297` | Option shapes | 4 field(s) |
|
|
97
|
+
| `DataFabricFilter` | interface | `dist/core/actions.d.ts:2099-2130` | 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:2088-2098` | 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:3175-3213` | Actions | Query entity records from Data Fabric (`core.datafabric.read`). |
|
|
100
|
+
| `DataFabricReadInputs` | interface | `dist/core/actions.d.ts:2155-2207` | Option shapes | 9 field(s) |
|
|
101
|
+
| `DataFabricRecordRef` | type | `dist/core/actions.d.ts:2138-2154` | Supporting types | Which record a Data Fabric write targets — exactly ONE of the two forms. |
|
|
102
|
+
| `DataFabricSort` | interface | `dist/core/actions.d.ts:2131-2137` | Supporting types | How a multi-record query orders its rows before the limit is applied. |
|
|
103
|
+
| `dataFabricUpdate` | function | `dist/core/actions.d.ts:3232-3247` | Actions | Update an entity record in Data Fabric (`core.datafabric.update`). |
|
|
104
|
+
| `DataFabricUpdateInputs` | interface | `dist/core/actions.d.ts:2239-2270` | Option shapes | 5 field(s) |
|
|
105
105
|
| `DEFAULT_TRIGGER_ID` | const | `dist/core/expr.d.ts:42-43` | Expressions and types | The manual trigger node's default id. |
|
|
106
106
|
| `DefinitionReference` | type | `dist/core/node-classes.d.ts:30-63` | Supporting types | An exact reference to the node definition a contribution compiles against. |
|
|
107
|
-
| `delay` | function | `dist/core/actions.d.ts:
|
|
107
|
+
| `delay` | function | `dist/core/actions.d.ts:2710-2731` | Actions | Declare a delay — a step that pauses the flow for a fixed length of time and then carries on. |
|
|
108
108
|
| `DELAY_PRESETS` | const | `dist/core/actions.d.ts:945-952` | Actions | The twelve durations the designer's dropdown offers. |
|
|
109
109
|
| `DelayInputs` | type | `dist/core/actions.d.ts:953-974` | Option shapes | |
|
|
110
110
|
| `descriptor` | function | `dist/core/connectors.d.ts:98-110` | Generated descriptors | Brand a descriptor literal with its input/output types (zero runtime cost). |
|
|
111
|
-
| `documentClassify` | function | `dist/core/actions.d.ts:
|
|
112
|
-
| `DocumentClassifyInputs` | interface | `dist/core/actions.d.ts:
|
|
111
|
+
| `documentClassify` | function | `dist/core/actions.d.ts:3155-3163` | Actions | Classify a document into a document type (`uipath.document.classify`). |
|
|
112
|
+
| `DocumentClassifyInputs` | interface | `dist/core/actions.d.ts:2298-2307` | Option shapes | 4 field(s) |
|
|
113
113
|
| `DocValidationInputs` | interface | `dist/core/actions.d.ts:444-467` | Option shapes | The Document Validation task's subject — `variant: 'document-validation'` only. |
|
|
114
114
|
| `DoWhileOptions` | interface | `dist/flow-sdk.d.ts:447-456` | Option shapes | Do-while options. |
|
|
115
|
-
| `dynamicExtract` | function | `dist/core/actions.d.ts:
|
|
116
|
-
| `DynamicExtractInputs` | interface | `dist/core/actions.d.ts:
|
|
115
|
+
| `dynamicExtract` | function | `dist/core/actions.d.ts:3164-3174` | 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:2308-2342` | Option shapes | 5 field(s) |
|
|
117
117
|
| `EdgeRoute` | interface | `dist/flow-sdk.d.ts:584-598` | Supporting types | One edge's route: user-dragged bends and/or the auto-router's waypoints. |
|
|
118
|
-
| `endCall` | function | `dist/core/actions.d.ts:
|
|
118
|
+
| `endCall` | function | `dist/core/actions.d.ts:2945-2952` | Actions | Hang up (`uipath.conversational.voice.end-call`). |
|
|
119
119
|
| `EndCallInputs` | interface | `dist/core/actions.d.ts:732-739` | Option shapes | 1 field(s) |
|
|
120
120
|
| `entryInput` | function | `dist/core/expr.d.ts:62-72` | Expressions and types | Reference an ENTRY POINT's scoped input: `entryInput('nightly', 'batchDate')` reads `$vars.nightly.output.batchDate` —… |
|
|
121
121
|
| `err` | function | `dist/core/expr.d.ts:153-240` | Expressions and types | Reference a FAILED step's error → `$vars.<step>.error[.<field>]`. |
|
|
122
122
|
| `ErrorEnvelopeField` | type | `dist/core/expr.d.ts:142-152` | Supporting types | The fields a failure envelope carries. |
|
|
123
|
-
| `EscalationRef` | interface | `dist/core/actions.d.ts:
|
|
124
|
-
| `EventFilter` | type | `dist/core/actions.d.ts:
|
|
125
|
-
| `EventSubscription` | interface | `dist/core/actions.d.ts:
|
|
123
|
+
| `EscalationRef` | interface | `dist/core/actions.d.ts:1915-1976` | Supporting types | One escalation an inline agent may raise — an Action Center app task a human completes (the `coded-action-app` variant,… |
|
|
124
|
+
| `EventFilter` | type | `dist/core/actions.d.ts:3353-3394` | Supporting types | One filter condition on the event payload. |
|
|
125
|
+
| `EventSubscription` | interface | `dist/core/actions.d.ts:3443-3484` | Option shapes | What a connector event subscribes to. |
|
|
126
126
|
| `Expr` | class | `dist/core/expr.d.ts:11-21` | Supporting types | A Flow expression. |
|
|
127
127
|
| `FieldMapping` | interface | `dist/core/actions.d.ts:250-257` | Supporting types | 3 field(s) |
|
|
128
128
|
| `FilterCondition` | type | `dist/core/actions.d.ts:233-234` | Supporting types | Comparison a filter rule applies to a field. |
|
|
@@ -145,27 +145,27 @@ could hand you spans for a version you do not have.
|
|
|
145
145
|
| `GuardrailRule` | type | `dist/core/actions.d.ts:1298-1317` | Supporting types | One condition of a custom guardrail. |
|
|
146
146
|
| `GuardrailScope` | type | `dist/core/actions.d.ts:1277-1278` | Supporting types | Where a guardrail applies: the whole agent, its LLM calls, or its tools. |
|
|
147
147
|
| `GuardrailSelector` | interface | `dist/core/actions.d.ts:1279-1284` | Supporting types | Which artifacts inside the scope the guardrail watches. |
|
|
148
|
-
| `hitl` | function | `dist/core/actions.d.ts:
|
|
148
|
+
| `hitl` | function | `dist/core/actions.d.ts:2527-2578` | Actions | Declare a human task — a step that pauses for a person to read some values, fill others in, and press one of the outcome… |
|
|
149
149
|
| `HitlAssigneeType` | type | `dist/core/actions.d.ts:390-397` | Supporting types | How the task is assigned, the platform's own vocabulary (canvas `HITL_ASSIGNEE_TYPE`): `'user'` a single user, `'group'`… |
|
|
150
150
|
| `HitlChannel` | type | `dist/core/actions.d.ts:384-389` | Supporting types | Where the task is delivered. |
|
|
151
151
|
| `HitlConnection` | interface | `dist/core/actions.d.ts:398-406` | Supporting types | A per-channel Integration Service connection (Slack / Teams delivery). |
|
|
152
152
|
| `HitlInputs` | interface | `dist/core/actions.d.ts:552-623` | Option shapes | 11 field(s) |
|
|
153
153
|
| `HitlRecipient` | interface | `dist/core/actions.d.ts:407-443` | Supporting types | Who gets the task and over which channels. |
|
|
154
154
|
| `HitlVariant` | type | `dist/core/actions.d.ts:480-505` | Supporting types | WHICH human-task node type to emit. |
|
|
155
|
-
| `http` | function | `dist/core/actions.d.ts:
|
|
155
|
+
| `http` | function | `dist/core/actions.d.ts:2465-2472` | Actions | Declare an HTTP request action, explicitly choosing standalone or managed. |
|
|
156
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. |
|
|
157
157
|
| `HttpInputs` | type | `dist/core/actions.d.ts:131-148` | Option shapes | |
|
|
158
158
|
| `HttpInputsBase` | interface | `dist/core/actions.d.ts:30-130` | Option shapes | 11 field(s) |
|
|
159
|
-
| `HttpRequestToolRef` | interface | `dist/core/actions.d.ts:
|
|
160
|
-
| `inlineAgent` | function | `dist/core/actions.d.ts:
|
|
159
|
+
| `HttpRequestToolRef` | interface | `dist/core/actions.d.ts:1718-1747` | Supporting types | The built-in HTTP-request tool (`uipath.agent.resource.tool.builtin.httprequest`): the agent performs an HTTP call. |
|
|
160
|
+
| `inlineAgent` | function | `dist/core/actions.d.ts:3104-3154` | Actions | Declare an INLINE AUTONOMOUS AGENT — an agent defined inside this flow's own project rather than published to… |
|
|
161
161
|
| `InlineAgentFieldType` | type | `dist/core/actions.d.ts:1257-1258` | Supporting types | A JSON-schema-ish type for one field of an inline agent's input/output schema. |
|
|
162
|
-
| `InlineAgentInputs` | interface | `dist/core/actions.d.ts:1385-
|
|
162
|
+
| `InlineAgentInputs` | interface | `dist/core/actions.d.ts:1385-1639` | Option shapes | 16 field(s) |
|
|
163
163
|
| `InOutField` | interface | `dist/core/actions.d.ts:365-382` | Supporting types | A value the reviewer READS **and can correct**: pre-filled from the flow, editable on the form, and the (possibly… |
|
|
164
164
|
| `input` | function | `dist/core/expr.d.ts:44-61` | Expressions and types | Reference a flow input by name → `$vars.<triggerId>.output.<name>`. |
|
|
165
165
|
| `isLookupToken` | function | `dist/core/lookups.d.ts:53-54` | Generated descriptors | True when `v` is an unresolved LookupToken. |
|
|
166
|
-
| `ixpExtract` | function | `dist/core/actions.d.ts:
|
|
166
|
+
| `ixpExtract` | function | `dist/core/actions.d.ts:2655-2709` | Actions | Extract fields from a document with a published IxP project — the platform's **Extract** node (`uipath.ixp.*`, service… |
|
|
167
167
|
| `IxpExtractInputs` | interface | `dist/core/actions.d.ts:870-944` | Option shapes | 9 field(s) |
|
|
168
|
-
| `IxpToolRef` | interface | `dist/core/actions.d.ts:
|
|
168
|
+
| `IxpToolRef` | interface | `dist/core/actions.d.ts:1876-1914` | Supporting types | A published IxP (Intelligent eXtraction Platform) project as a tool — the agent decides when to extract a document and… |
|
|
169
169
|
| `js` | function | `dist/core/expr.d.ts:241-252` | Expressions and types | Build a raw JS *expression* (a condition or computation). |
|
|
170
170
|
| `lit` | function | `dist/core/expr.d.ts:22-28` | Expressions and types | A constant value baked directly into a node input. |
|
|
171
171
|
| `lookup` | function | `dist/core/lookups.d.ts:95-102` | Generated descriptors | Begin resolving a lookup field on a generated descriptor. |
|
|
@@ -182,8 +182,8 @@ could hand you spans for a version you do not have.
|
|
|
182
182
|
| `LookupToken` | interface | `dist/core/lookups.d.ts:37-52` | Generated descriptors | An unresolved lookup: what `.byEmail(…)` returns. |
|
|
183
183
|
| `LoopOptions` | interface | `dist/flow-sdk.d.ts:426-446` | Option shapes | Loop-specific options. |
|
|
184
184
|
| `manual` | function | `dist/flow-sdk.d.ts:169-178` | Flow construction | The manual trigger, explicitly. |
|
|
185
|
-
| `McpToolRef` | interface | `dist/core/actions.d.ts:
|
|
186
|
-
| `mock` | function | `dist/core/actions.d.ts:
|
|
185
|
+
| `McpToolRef` | interface | `dist/core/actions.d.ts:1652-1680` | Supporting types | An MCP server the agent may call tools on. |
|
|
186
|
+
| `mock` | function | `dist/core/actions.d.ts:2732-2771` | Actions | Declare a PLACEHOLDER step — "a real node goes here later". |
|
|
187
187
|
| `NodeContribution` | interface | `dist/core/node-classes.d.ts:98-121` | Supporting types | One validated construct, returned by FlowNode.contribute. |
|
|
188
188
|
| `NodeLayout` | interface | `dist/flow-sdk.d.ts:569-583` | Supporting types | One node's designer layout: canvas position, and optionally size and collapsed state. |
|
|
189
189
|
| `NodeOptions` | interface | `dist/flow-sdk.d.ts:348-393` | Option shapes | Options shared by every builder method that creates a definition-backed node: `version` selects the exact node… |
|
|
@@ -193,33 +193,33 @@ could hand you spans for a version you do not have.
|
|
|
193
193
|
| `Outcome` | type | `dist/core/actions.d.ts:468-479` | Supporting types | One completion button. |
|
|
194
194
|
| `OutputColumn` | interface | `dist/core/actions.d.ts:830-836` | Supporting types | One column Batch Transform appends to the CSV. |
|
|
195
195
|
| `PortArm` | interface | `dist/flow-sdk.d.ts:335-347` | Supporting types | One arm of a built `.stepSwitch` — the same shape as SwitchArm, but `value` names an exit the ACTION declares (a… |
|
|
196
|
-
| `ProcessToolKind` | type | `dist/core/actions.d.ts:
|
|
197
|
-
| `ProcessToolRef` | interface | `dist/core/actions.d.ts:
|
|
198
|
-
| `publishedFunction` | function | `dist/core/actions.d.ts:
|
|
196
|
+
| `ProcessToolKind` | type | `dist/core/actions.d.ts:1832-1845` | Supporting types | The tool kinds that wrap a DEPLOYED tenant resource. |
|
|
197
|
+
| `ProcessToolRef` | interface | `dist/core/actions.d.ts:1846-1875` | Supporting types | A deployed tenant resource the agent may invoke. |
|
|
198
|
+
| `publishedFunction` | function | `dist/core/actions.d.ts:2852-2876` | Actions | Invoke a published Orchestrator **Function** — a deployed unit of code run as one step (`uipath.core.function.<key>`,… |
|
|
199
199
|
| `PublishedFunctionInputs` | interface | `dist/core/actions.d.ts:1045-1079` | Option shapes | A published Orchestrator **Function** — a small, single-purpose unit of code deployed as its own resource and invoked as… |
|
|
200
|
-
| `queueItem` | function | `dist/core/actions.d.ts:
|
|
201
|
-
| `QueueItemInputs` | interface | `dist/core/actions.d.ts:
|
|
202
|
-
| `QueuePriority` | type | `dist/core/actions.d.ts:2013
|
|
200
|
+
| `queueItem` | function | `dist/core/actions.d.ts:3266-3311` | Actions | Declare an Orchestrator QUEUE ITEM step. |
|
|
201
|
+
| `QueueItemInputs` | interface | `dist/core/actions.d.ts:2014-2087` | Option shapes | 10 field(s) |
|
|
202
|
+
| `QueuePriority` | type | `dist/core/actions.d.ts:2012-2013` | Supporting types | The three priorities an Orchestrator queue item can carry. |
|
|
203
203
|
| `ran` | function | `dist/core/expr.d.ts:95-141` | Expressions and types | Did this step run? |
|
|
204
204
|
| `rawNode` | function | `dist/core/node-classes.d.ts:180-242` | Supporting types | Place a node this SDK has no factory for, carrying its definition verbatim (`uipath.exotic.thing@2.1` and the manifest… |
|
|
205
205
|
| `RawReference` | type | `dist/core/lookups.d.ts:190-198` | Supporting types | |
|
|
206
206
|
| `refuseLookupToken` | function | `dist/core/lookups.d.ts:207-226` | Generated descriptors | Refuse a lookup token where the family cannot resolve one. |
|
|
207
|
-
| `RemoteA2aToolRef` | interface | `dist/core/actions.d.ts:
|
|
207
|
+
| `RemoteA2aToolRef` | interface | `dist/core/actions.d.ts:1681-1701` | Supporting types | A remote A2A (agent-to-agent) endpoint the agent may delegate to. |
|
|
208
208
|
| `resolvedValue` | function | `dist/core/lookups.d.ts:172-179` | Generated descriptors | The recorded id for a token, or `undefined`. |
|
|
209
209
|
| `ReturnFieldType` | type | `dist/core/actions.d.ts:1259-1276` | Supporting types | A JSON-schema-ish type for one field of a step's declared `returns`. |
|
|
210
210
|
| `ReturnOptions` | interface | `dist/flow-sdk.d.ts:394-425` | Option shapes | `.return(...)`-specific options. |
|
|
211
|
-
| `rpaWorkflow` | function | `dist/core/actions.d.ts:
|
|
211
|
+
| `rpaWorkflow` | function | `dist/core/actions.d.ts:2772-2816` | Actions | Invoke a deployed RPA (robotic process automation) workflow — a classic UI-automation process, published to… |
|
|
212
212
|
| `RpaWorkflowInputs` | interface | `dist/core/actions.d.ts:975-1012` | Option shapes | 5 field(s) |
|
|
213
213
|
| `SCHEDULE_PRESETS` | const | `dist/flow-sdk.d.ts:116-123` | Flow construction | The eight intervals the designer offers in its Frequency dropdown. |
|
|
214
214
|
| `scheduled` | function | `dist/flow-sdk.d.ts:226-245` | Flow construction | Start the flow on a recurring schedule instead of on demand. |
|
|
215
215
|
| `ScheduledInputs` | interface | `dist/flow-sdk.d.ts:137-149` | Option shapes | 1 field(s) |
|
|
216
216
|
| `ScheduleEvery` | type | `dist/flow-sdk.d.ts:125-136` | Supporting types | How often a scheduled flow runs, as an ISO-8601 repeating interval: `R/` followed by a duration. |
|
|
217
217
|
| `SchedulePreset` | type | `dist/flow-sdk.d.ts:124` | Supporting types | |
|
|
218
|
-
| `script` | function | `dist/core/actions.d.ts:
|
|
218
|
+
| `script` | function | `dist/core/actions.d.ts:2473-2480` | Actions | Declare an inline script action. |
|
|
219
219
|
| `ScriptInputs` | interface | `dist/core/actions.d.ts:149-186` | Option shapes | 2 field(s) |
|
|
220
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… |
|
|
221
221
|
| `ScriptReturnType` | type | `dist/core/script-return.d.ts:31-32` | Supporting types | The vocabulary a script's output can be declared as. |
|
|
222
|
-
| `sendMessage` | function | `dist/core/actions.d.ts:
|
|
222
|
+
| `sendMessage` | function | `dist/core/actions.d.ts:2877-2895` | Actions | Post an assistant message into a live conversation (`uipath.conversational.send-message`). |
|
|
223
223
|
| `SendMessageInputs` | interface | `dist/core/actions.d.ts:624-643` | Option shapes | 4 field(s) |
|
|
224
224
|
| `ShownField` | interface | `dist/core/actions.d.ts:338-353` | Supporting types | A value the reviewer READS: shown on the form, filled in from the flow. |
|
|
225
225
|
| `Step` | type | `dist/flow-sdk.d.ts:457-568` | Supporting types | |
|
|
@@ -229,12 +229,12 @@ could hand you spans for a version you do not have.
|
|
|
229
229
|
| `StickyNoteColor` | type | `dist/flow-sdk.d.ts:605-610` | Supporting types | A sticky note's swatch. |
|
|
230
230
|
| `subflow` | function | `dist/flow-sdk.d.ts:1440-1479` | Flow construction | Run another flow as one step, and read back what it returns. |
|
|
231
231
|
| `SubflowSpec` | interface | `dist/flow-sdk.d.ts:33-40` | Supporting types | A step that runs a child flow. |
|
|
232
|
-
| `summarize` | function | `dist/core/actions.d.ts:
|
|
232
|
+
| `summarize` | function | `dist/core/actions.d.ts:2579-2619` | Actions | Summarize a document with citations — the platform's **Summarize** node. |
|
|
233
233
|
| `SummarizeInputs` | interface | `dist/core/actions.d.ts:797-829` | Option shapes | 3 field(s) |
|
|
234
234
|
| `SwitchArm` | interface | `dist/flow-sdk.d.ts:329-334` | Supporting types | One arm of a built `.switch` (the serializer's view: body already collected). |
|
|
235
235
|
| `tmpl` | function | `dist/core/expr.d.ts:253-263` | Expressions and types | Build a JS *string template* (for URLs, messages, etc.). |
|
|
236
|
-
| `ToolRef` | type | `dist/core/actions.d.ts:
|
|
237
|
-
| `transform` | function | `dist/core/actions.d.ts:
|
|
236
|
+
| `ToolRef` | type | `dist/core/actions.d.ts:1642-1651` | Supporting types | One tool on an inline agent — a discriminated union over the kinds the tenant's registry actually serves… |
|
|
237
|
+
| `transform` | function | `dist/core/actions.d.ts:2481-2526` | Actions | Declare a Transform action — a chain of declarative operations over a collection. |
|
|
238
238
|
| `Transformation` | type | `dist/core/actions.d.ts:248-249` | Supporting types | What a map does to a field's value. |
|
|
239
239
|
| `TransformInputs` | interface | `dist/core/actions.d.ts:307-331` | Option shapes | 3 field(s) |
|
|
240
240
|
| `TransformOperation` | type | `dist/core/actions.d.ts:266-283` | Supporting types | One link in the chain. |
|
|
@@ -242,7 +242,7 @@ could hand you spans for a version you do not have.
|
|
|
242
242
|
| `triggerDescriptor` | function | `dist/core/connectors.d.ts:139-151` | Generated descriptors | Brand a trigger descriptor literal with its where/output types. |
|
|
243
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. |
|
|
244
244
|
| `TriggerMeta` | interface | `dist/core/connectors.d.ts:120-129` | Generated descriptors | Runtime metadata a generated trigger descriptor carries. |
|
|
245
|
-
| `TriggerOptions` | interface | `dist/core/actions.d.ts:
|
|
245
|
+
| `TriggerOptions` | interface | `dist/core/actions.d.ts:3395-3442` | Option shapes | The typed `onEvent`/`waitForEvent` options — everything an EventSubscription carries except `connector`/`event`, which… |
|
|
246
246
|
| `TriggerSpec` | type | `dist/flow-sdk.d.ts:150-168` | Supporting types | What starts the flow. |
|
|
247
247
|
| `TypeDesc` | type | `dist/core/expr.d.ts:328` | Supporting types | |
|
|
248
248
|
| `types` | const | `dist/core/expr.d.ts:312-327` | Expressions and types | Variable type descriptors (map to Flow variable `type` values). |
|
|
@@ -250,13 +250,13 @@ could hand you spans for a version you do not have.
|
|
|
250
250
|
| `v` | function | `dist/core/expr.d.ts:29-41` | Expressions and types | Reference a flow variable or output by name → `$vars.<name>`. |
|
|
251
251
|
| `VarDecl` | interface | `dist/flow-sdk.d.ts:47-59` | Supporting types | 7 field(s) |
|
|
252
252
|
| `VarSpec` | interface | `dist/flow-sdk.d.ts:60-115` | Supporting types | The rich spelling of a variable declaration: pass it instead of a bare `types.*` descriptor wherever `.input()` /… |
|
|
253
|
-
| `voiceAgent` | function | `dist/core/actions.d.ts:
|
|
253
|
+
| `voiceAgent` | function | `dist/core/actions.d.ts:2953-2977` | Actions | Put a VOICE agent on a live call (`uipath.agent.voice`) — it speaks and listens for one turn, then the flow continues. |
|
|
254
254
|
| `VoiceAgentInputs` | interface | `dist/core/actions.d.ts:763-796` | Option shapes | 6 field(s) |
|
|
255
255
|
| `VoiceSettings` | interface | `dist/core/actions.d.ts:740-762` | Supporting types | The audio settings a voice agent speaks with. |
|
|
256
256
|
| `voiceTrigger` | function | `dist/flow-sdk.d.ts:302-326` | Flow construction | Start the flow when a phone call comes IN (`core.trigger.voice`). |
|
|
257
|
-
| `waitForEvent` | function | `dist/core/actions.d.ts:
|
|
258
|
-
| `waitForEvent` | function | `dist/core/actions.d.ts:
|
|
259
|
-
| `waitForMessage` | function | `dist/core/actions.d.ts:
|
|
257
|
+
| `waitForEvent` | function | `dist/core/actions.d.ts:3494-3529` | 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:3530-3537` | Actions | Stringly form, for an event with no prepared module. |
|
|
259
|
+
| `waitForMessage` | function | `dist/core/actions.d.ts:2896-2912` | Actions | PAUSE until the person sends their next message (`uipath.conversational.wait-for-message`) — a catch event, like… |
|
|
260
260
|
| `WaitForMessageInputs` | interface | `dist/core/actions.d.ts:644-652` | Option shapes | 2 field(s) |
|
|
261
261
|
|
|
262
262
|
## `@uipath/maestro-builder-sdk/case`
|
|
@@ -299,8 +299,8 @@ could hand you spans for a version you do not have.
|
|
|
299
299
|
| `EscalationOpts` | interface | `dist/case/case-sdk.d.ts:127-139` | Option shapes | 4 field(s) |
|
|
300
300
|
| `EscalationRecipient` | interface | `dist/case/case-sdk.d.ts:119-126` | Supporting types | Who an escalation notifies. |
|
|
301
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`). |
|
|
302
|
-
| `EventFilter` | type | `dist/core/actions.d.ts:
|
|
303
|
-
| `EventSubscription` | interface | `dist/core/actions.d.ts:
|
|
302
|
+
| `EventFilter` | type | `dist/core/actions.d.ts:3353-3394` | Supporting types | One filter condition on the event payload. |
|
|
303
|
+
| `EventSubscription` | interface | `dist/core/actions.d.ts:3443-3484` | Option shapes | What a connector event subscribes to. |
|
|
304
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. |
|
|
305
305
|
| `eventTrigger` | function | `dist/case/case-sdk.d.ts:287-293` | Case authoring | An Integration Service event trigger in placeholder or stringly-resolved form. |
|
|
306
306
|
| `EventTriggerOpts` | interface | `dist/case/case-sdk.d.ts:239-263` | Option shapes | 4 field(s) |
|
|
@@ -336,7 +336,7 @@ could hand you spans for a version you do not have.
|
|
|
336
336
|
| `toUser` | function | `dist/case/case-sdk.d.ts:150-157` | Case authoring | An escalation recipient that is a single user. |
|
|
337
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. |
|
|
338
338
|
| `TriggerMeta` | interface | `dist/core/connectors.d.ts:120-129` | Supporting types | Runtime metadata a generated trigger descriptor carries. |
|
|
339
|
-
| `TriggerOptions` | interface | `dist/core/actions.d.ts:
|
|
339
|
+
| `TriggerOptions` | interface | `dist/core/actions.d.ts:3395-3442` | Option shapes | The typed `onEvent`/`waitForEvent` options — everything an EventSubscription carries except `connector`/`event`, which… |
|
|
340
340
|
| `TypeDesc` | type | `dist/core/expr.d.ts:328` | Supporting types | |
|
|
341
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. |
|
|
342
342
|
| `WaitConnectorPlaceholderSpec` | interface | `dist/case/case-sdk.d.ts:360-370` | Supporting types | A `wait-for-connector` subscription: suspend on an Integration Service event. |
|
|
@@ -387,7 +387,7 @@ could hand you spans for a version you do not have.
|
|
|
387
387
|
| `errorSchema` | const | `dist/bpmn/bpmn-sdk.d.ts:3541-3582` | BPMN authoring | The `Error` variable's shape — the platform's own error envelope. |
|
|
388
388
|
| `errorSchemaWithResponse` | const | `dist/bpmn/bpmn-sdk.d.ts:3583-3615` | BPMN authoring | The same envelope plus `response` — what a node whose failure carries a payload writes, and what the same source calls… |
|
|
389
389
|
| `EventDef` | type | `dist/bpmn/bpmn-sdk.d.ts:53-71` | Supporting types | The resolved event definition attached to an event node. |
|
|
390
|
-
| `EventFilter` | type | `dist/core/actions.d.ts:
|
|
390
|
+
| `EventFilter` | type | `dist/core/actions.d.ts:3353-3394` | Supporting types | One filter condition on the event payload. |
|
|
391
391
|
| `EventKind` | type | `dist/bpmn/bpmn-sdk.d.ts:74-75` | Supporting types | The four non-boundary event element kinds a BpmnNode can be. |
|
|
392
392
|
| `EventSubProcessOpts` | interface | `dist/bpmn/bpmn-sdk.d.ts:1834-1894` | Option shapes | Options for ScopeBuilder.eventSubProcess. |
|
|
393
393
|
| `ExtensionPayload` | interface | `dist/bpmn/bpmn-sdk.d.ts:556-592` | Supporting types | An extension payload carried by an element the payload does not describe. |
|