@uipath/maestro-builder-sdk 6.18.10 → 6.19.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 +185 -184
- package/dist/api-members.md +504 -473
- package/dist/check.js +177 -650
- package/dist/core/actions.d.ts +119 -760
- package/dist/core/actions.js +0 -306
- package/dist/core/error-port.d.ts +6 -0
- package/dist/core/error-port.js +9 -0
- package/dist/core/node-classes.d.ts +4 -63
- package/dist/core/node-classes.js +0 -112
- package/dist/core/nodes/family.d.ts +36 -0
- package/dist/core/nodes/family.js +1 -0
- package/dist/core/nodes/node-type.d.ts +136 -0
- package/dist/core/nodes/node-type.js +1 -0
- package/dist/core/nodes/registry.d.ts +57 -0
- package/dist/core/nodes/registry.js +122 -0
- package/dist/core/nodes/versioned.d.ts +50 -0
- package/dist/core/nodes/versioned.js +46 -0
- package/dist/core/typed-raw-node.d.ts +13 -62
- package/dist/core/typed-raw-node.js +40 -154
- package/dist/decompile.js +92 -271
- package/dist/flow-definitions.d.ts +10 -0
- package/dist/flow-definitions.js +35 -0
- package/dist/flow-node-registry.d.ts +13 -0
- package/dist/flow-node-registry.js +19 -0
- package/dist/flow-node-type.d.ts +192 -0
- package/dist/flow-node-type.js +1 -0
- package/dist/flow-sdk.d.ts +7 -0
- package/dist/flow-sdk.js +8 -0
- package/dist/nodes/data-fabric/flow/check.d.ts +13 -0
- package/dist/nodes/data-fabric/flow/check.js +164 -0
- package/dist/nodes/data-fabric/flow/factories.d.ts +113 -0
- package/dist/nodes/data-fabric/flow/factories.js +134 -0
- package/dist/nodes/data-fabric/flow/family.d.ts +7 -0
- package/dist/nodes/data-fabric/flow/family.js +9 -0
- package/dist/nodes/data-fabric/flow/index.d.ts +8 -0
- package/dist/nodes/data-fabric/flow/index.js +8 -0
- package/dist/nodes/data-fabric/flow/raw.d.ts +32 -0
- package/dist/nodes/data-fabric/flow/raw.js +100 -0
- package/dist/nodes/data-fabric/flow/shared.d.ts +77 -0
- package/dist/nodes/data-fabric/flow/shared.js +174 -0
- package/dist/nodes/data-fabric/flow/spec.d.ts +238 -0
- package/dist/nodes/data-fabric/flow/spec.js +1 -0
- package/dist/nodes/data-fabric/flow/verbs.d.ts +29 -0
- package/dist/nodes/data-fabric/flow/verbs.js +239 -0
- package/dist/nodes/delay/flow/check.d.ts +16 -0
- package/dist/nodes/delay/flow/check.js +86 -0
- package/dist/nodes/delay/flow/factories.d.ts +28 -0
- package/dist/nodes/delay/flow/factories.js +38 -0
- package/dist/nodes/delay/flow/family.d.ts +3 -0
- package/dist/nodes/delay/flow/family.js +8 -0
- package/dist/nodes/delay/flow/index.d.ts +3 -0
- package/dist/nodes/delay/flow/index.js +3 -0
- package/dist/nodes/delay/flow/node-type.d.ts +13 -0
- package/dist/nodes/delay/flow/node-type.js +71 -0
- package/dist/nodes/delay/flow/spec.d.ts +43 -0
- package/dist/nodes/delay/flow/spec.js +16 -0
- package/dist/nodes/document/flow/factories.d.ts +27 -0
- package/dist/nodes/document/flow/factories.js +30 -0
- package/dist/nodes/document/flow/family.d.ts +3 -0
- package/dist/nodes/document/flow/family.js +7 -0
- package/dist/nodes/document/flow/index.d.ts +3 -0
- package/dist/nodes/document/flow/index.js +3 -0
- package/dist/nodes/document/flow/node-type.d.ts +14 -0
- package/dist/nodes/document/flow/node-type.js +150 -0
- package/dist/nodes/document/flow/spec.d.ts +65 -0
- package/dist/nodes/document/flow/spec.js +1 -0
- package/dist/nodes/mock/flow/factories.d.ts +51 -0
- package/dist/nodes/mock/flow/factories.js +47 -0
- package/dist/nodes/mock/flow/family.d.ts +3 -0
- package/dist/nodes/mock/flow/family.js +7 -0
- package/dist/nodes/mock/flow/index.d.ts +2 -0
- package/dist/nodes/mock/flow/index.js +2 -0
- package/dist/nodes/mock/flow/node-type.d.ts +11 -0
- package/dist/nodes/mock/flow/node-type.js +51 -0
- package/dist/nodes/script/flow/check.d.ts +19 -0
- package/dist/nodes/script/flow/check.js +49 -0
- package/dist/nodes/script/flow/factories.d.ts +14 -0
- package/dist/nodes/script/flow/factories.js +15 -0
- package/dist/nodes/script/flow/family.d.ts +3 -0
- package/dist/nodes/script/flow/family.js +8 -0
- package/dist/nodes/script/flow/index.d.ts +3 -0
- package/dist/nodes/script/flow/index.js +3 -0
- package/dist/nodes/script/flow/node-type.d.ts +7 -0
- package/dist/nodes/script/flow/node-type.js +125 -0
- package/dist/nodes/script/flow/spec.d.ts +52 -0
- package/dist/nodes/script/flow/spec.js +1 -0
- package/dist/nodes/transform/flow/check.d.ts +6 -0
- package/dist/nodes/transform/flow/check.js +229 -0
- package/dist/nodes/transform/flow/factories.d.ts +52 -0
- package/dist/nodes/transform/flow/factories.js +53 -0
- package/dist/nodes/transform/flow/family.d.ts +3 -0
- package/dist/nodes/transform/flow/family.js +8 -0
- package/dist/nodes/transform/flow/index.d.ts +3 -0
- package/dist/nodes/transform/flow/index.js +3 -0
- package/dist/nodes/transform/flow/node-type.d.ts +7 -0
- package/dist/nodes/transform/flow/node-type.js +244 -0
- package/dist/nodes/transform/flow/spec.d.ts +116 -0
- package/dist/nodes/transform/flow/spec.js +10 -0
- package/dist/raw-node-advice.d.ts +16 -0
- package/dist/raw-node-advice.js +36 -0
- package/dist/raw-node.d.ts +71 -0
- package/dist/raw-node.js +116 -0
- package/dist/serialize.js +138 -492
- package/package.json +2 -2
package/dist/api-index.md
CHANGED
|
@@ -37,135 +37,136 @@ could hand you spans for a version you do not have.
|
|
|
37
37
|
|
|
38
38
|
## `@uipath/maestro-builder-sdk`
|
|
39
39
|
|
|
40
|
-
|
|
40
|
+
219 symbol(s). Import from `@uipath/maestro-builder-sdk`.
|
|
41
41
|
|
|
42
42
|
| Symbol | Kind | Declaration | Area | Summary |
|
|
43
43
|
| --- | --- | --- | --- | --- |
|
|
44
|
-
| `ActionSpec` | type | `dist/core/actions.d.ts:
|
|
45
|
-
| `agent` | function | `dist/core/actions.d.ts:
|
|
46
|
-
| `AgentFlavour` | type | `dist/core/actions.d.ts:
|
|
47
|
-
| `AgentGuardrail` | type | `dist/core/actions.d.ts:
|
|
48
|
-
| `agenticProcess` | function | `dist/core/actions.d.ts:
|
|
49
|
-
| `AgenticProcessCompletion` | type | `dist/core/actions.d.ts:
|
|
50
|
-
| `AgenticProcessInputs` | type | `dist/core/actions.d.ts:
|
|
51
|
-
| `AgenticProcessInputsBase` | interface | `dist/core/actions.d.ts:
|
|
52
|
-
| `AgentInputs` | interface | `dist/core/actions.d.ts:
|
|
53
|
-
| `AgentLocation` | type | `dist/core/actions.d.ts:
|
|
54
|
-
| `AgentMemoryRef` | interface | `dist/core/actions.d.ts:
|
|
55
|
-
| `Aggregation` | interface | `dist/
|
|
56
|
-
| `AggregationOperation` | type | `dist/
|
|
57
|
-
| `apiWorkflow` | function | `dist/core/actions.d.ts:
|
|
58
|
-
| `ApiWorkflowInputs` | interface | `dist/core/actions.d.ts:
|
|
59
|
-
| `AppRef` | interface | `dist/core/actions.d.ts:
|
|
60
|
-
| `ArmBuilder` | class | `dist/flow-sdk.d.ts:
|
|
61
|
-
| `AskedField` | interface | `dist/core/actions.d.ts:
|
|
62
|
-
| `batchTransform` | function | `dist/core/actions.d.ts:
|
|
63
|
-
| `BatchTransformInputs` | interface | `dist/core/actions.d.ts:
|
|
64
|
-
| `BindingContribution` | interface | `dist/core/node-classes.d.ts:
|
|
65
|
-
| `BuiltEntryPoint` | interface | `dist/flow-sdk.d.ts:
|
|
66
|
-
| `BuiltFlow` | interface | `dist/flow-sdk.d.ts:
|
|
67
|
-
| `BuiltinToolName` | type | `dist/core/actions.d.ts:
|
|
68
|
-
| `BuiltinToolRef` | interface | `dist/core/actions.d.ts:
|
|
69
|
-
| `BuiltInValidatorGuardrail` | interface | `dist/core/actions.d.ts:
|
|
70
|
-
| `CaseValue` | type | `dist/flow-sdk.d.ts:
|
|
71
|
-
| `ChildFlow` | type | `dist/flow-sdk.d.ts:
|
|
72
|
-
| `ClientSideToolRef` | interface | `dist/core/actions.d.ts:
|
|
73
|
-
| `connector` | function | `dist/core/actions.d.ts:
|
|
74
|
-
| `connector` | function | `dist/core/actions.d.ts:
|
|
44
|
+
| `ActionSpec` | type | `dist/core/actions.d.ts:2097-2105` | Supporting types | One action step's spec: `{ kind }` plus that kind's body from FlowActionSpecs, for every kind there. |
|
|
45
|
+
| `agent` | function | `dist/core/actions.d.ts:2602-2656` | Actions | Invoke an AGENT resource — either one published to Orchestrator or a sibling agent project registered in the same… |
|
|
46
|
+
| `AgentFlavour` | type | `dist/core/actions.d.ts:1044-1048` | Supporting types | Which KIND of agent project was published behind a `uipath.core.agent.<key>` resource. |
|
|
47
|
+
| `AgentGuardrail` | type | `dist/core/actions.d.ts:1272` | Supporting types | |
|
|
48
|
+
| `agenticProcess` | function | `dist/core/actions.d.ts:2556-2601` | Actions | Invoke a deployed AGENTIC PROCESS — a Maestro process orchestration published to Orchestrator: a BPMN process that… |
|
|
49
|
+
| `AgenticProcessCompletion` | type | `dist/core/actions.d.ts:1003-1041` | Supporting types | Whether an Agentic Process step waits for the process's result. |
|
|
50
|
+
| `AgenticProcessInputs` | type | `dist/core/actions.d.ts:1042-1043` | Option shapes | What `agenticProcess()` takes: the shared fields plus the completion policy. |
|
|
51
|
+
| `AgenticProcessInputsBase` | interface | `dist/core/actions.d.ts:946-1002` | Option shapes | 7 field(s) |
|
|
52
|
+
| `AgentInputs` | interface | `dist/core/actions.d.ts:1050-1144` | Option shapes | 8 field(s) |
|
|
53
|
+
| `AgentLocation` | type | `dist/core/actions.d.ts:1049` | Supporting types | |
|
|
54
|
+
| `AgentMemoryRef` | interface | `dist/core/actions.d.ts:1642-1666` | Supporting types | An episodic memory the agent learns from across runs, wired to the agent's own `memory` handle. |
|
|
55
|
+
| `Aggregation` | interface | `dist/nodes/transform/flow/spec.d.ts:36-42` | Supporting types | 3 field(s) |
|
|
56
|
+
| `AggregationOperation` | type | `dist/nodes/transform/flow/spec.d.ts:35` | Supporting types | |
|
|
57
|
+
| `apiWorkflow` | function | `dist/core/actions.d.ts:2370-2404` | Actions | Invoke a deployed API workflow — a coded workflow published to Orchestrator, run as a serverless job rather than by a… |
|
|
58
|
+
| `ApiWorkflowInputs` | interface | `dist/core/actions.d.ts:879-910` | Option shapes | 5 field(s) |
|
|
59
|
+
| `AppRef` | interface | `dist/core/actions.d.ts:366-411` | Supporting types | A deployed Action App that supplies a human task's form — the `'action-app'` variant's subject. |
|
|
60
|
+
| `ArmBuilder` | class | `dist/flow-sdk.d.ts:1147-1170` | Builders | The sub-builder an ARM callback receives — a `StepList` that can also name itself with `.label(...)`. |
|
|
61
|
+
| `AskedField` | interface | `dist/core/actions.d.ts:214-224` | Supporting types | A value the reviewer FILLS IN: read downstream with `out('<step>', '<id>')`. |
|
|
62
|
+
| `batchTransform` | function | `dist/core/actions.d.ts:2235-2269` | Actions | Add AI-generated columns to a CSV — the platform's **Batch transform** node, `uipath.pattern.batch-transform` (service… |
|
|
63
|
+
| `BatchTransformInputs` | interface | `dist/core/actions.d.ts:706-721` | Option shapes | 4 field(s) |
|
|
64
|
+
| `BindingContribution` | interface | `dist/core/node-classes.d.ts:80-101` | Supporting types | A resource binding a contribution hoists to the flow's top-level `bindings` array — the shape the `.flow` format… |
|
|
65
|
+
| `BuiltEntryPoint` | interface | `dist/flow-sdk.d.ts:670-682` | Supporting types | One additional flow root, built by `.entryPoint()`. |
|
|
66
|
+
| `BuiltFlow` | interface | `dist/flow-sdk.d.ts:683-718` | Supporting types | 15 field(s) |
|
|
67
|
+
| `BuiltinToolName` | type | `dist/core/actions.d.ts:1534-1535` | Supporting types | The three platform-shipped built-in tools (fixed registry types). |
|
|
68
|
+
| `BuiltinToolRef` | interface | `dist/core/actions.d.ts:1667-1687` | Supporting types | A platform built-in tool. |
|
|
69
|
+
| `BuiltInValidatorGuardrail` | interface | `dist/core/actions.d.ts:1230-1271` | Supporting types | A platform-shipped validator, configured by parameters. |
|
|
70
|
+
| `CaseValue` | type | `dist/flow-sdk.d.ts:334-335` | Supporting types | A value a `.switch` case compares the discriminant against. |
|
|
71
|
+
| `ChildFlow` | type | `dist/flow-sdk.d.ts:50-53` | Supporting types | Anything `subflow()` accepts as the child: a builder, or an already-built flow. |
|
|
72
|
+
| `ClientSideToolRef` | interface | `dist/core/actions.d.ts:1596-1611` | 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:2754-2777` | 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:2778-2794` | 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
|
-
| `ConnectorOpts` | interface | `dist/core/actions.d.ts:
|
|
79
|
-
| `ConnectorToolRef` | interface | `dist/core/actions.d.ts:
|
|
78
|
+
| `ConnectorOpts` | interface | `dist/core/actions.d.ts:148-191` | Option shapes | 4 field(s) |
|
|
79
|
+
| `ConnectorToolRef` | interface | `dist/core/actions.d.ts:1688-1725` | 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:
|
|
82
|
-
| `ContributionContext` | interface | `dist/core/node-classes.d.ts:
|
|
83
|
-
| `ContributionDiagnostic` | interface | `dist/core/node-classes.d.ts:
|
|
84
|
-
| `conversationalAgent` | function | `dist/core/actions.d.ts:
|
|
85
|
-
| `ConversationalAgentInputs` | interface | `dist/core/actions.d.ts:
|
|
86
|
-
| `ConversationalAgentSettings` | interface | `dist/core/actions.d.ts:
|
|
87
|
-
| `conversationContext` | function | `dist/core/actions.d.ts:
|
|
88
|
-
| `ConversationContextInputs` | interface | `dist/core/actions.d.ts:
|
|
89
|
-
| `conversationTrigger` | function | `dist/flow-sdk.d.ts:
|
|
90
|
-
| `createOutgoingCall` | function | `dist/core/actions.d.ts:
|
|
91
|
-
| `CreateOutgoingCallInputs` | interface | `dist/core/actions.d.ts:
|
|
92
|
-
| `CustomGuardrail` | interface | `dist/core/actions.d.ts:
|
|
93
|
-
| `dataFabricCreate` | function | `dist/
|
|
94
|
-
| `DataFabricCreateInputs` | interface | `dist/
|
|
95
|
-
| `dataFabricDelete` | function | `dist/
|
|
96
|
-
| `DataFabricDeleteInputs` | interface | `dist/
|
|
97
|
-
| `DataFabricFilter` | interface | `dist/
|
|
98
|
-
| `DataFabricOperator` | type | `dist/
|
|
99
|
-
| `dataFabricRead` | function | `dist/
|
|
100
|
-
| `DataFabricReadInputs` | interface | `dist/
|
|
101
|
-
| `DataFabricRecordRef` | type | `dist/
|
|
102
|
-
| `DataFabricSort` | interface | `dist/
|
|
103
|
-
| `dataFabricUpdate` | function | `dist/
|
|
104
|
-
| `DataFabricUpdateInputs` | interface | `dist/
|
|
81
|
+
| `ContextIndexRef` | interface | `dist/core/actions.d.ts:1876-1910` | Supporting types | One Context Grounding index an inline agent is grounded on. |
|
|
82
|
+
| `ContributionContext` | interface | `dist/core/node-classes.d.ts:68-79` | Supporting types | What the serializer tells a contributor before asking for its contribution. |
|
|
83
|
+
| `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. |
|
|
84
|
+
| `conversationalAgent` | function | `dist/core/actions.d.ts:2531-2555` | Actions | A CONVERSATIONAL agent (`uipath.agent.conversational`) — it answers one turn of a live chat, reading the transcript… |
|
|
85
|
+
| `ConversationalAgentInputs` | interface | `dist/core/actions.d.ts:545-591` | Option shapes | 10 field(s) |
|
|
86
|
+
| `ConversationalAgentSettings` | interface | `dist/core/actions.d.ts:521-544` | Supporting types | How a conversational agent gets its turn — the node's own `conversationalAgentSettings` sub-object. |
|
|
87
|
+
| `conversationContext` | function | `dist/core/actions.d.ts:2466-2480` | Actions | READ a conversation's transcript so far without waiting (`uipath.conversational.get-conversation-context`) — the shape a… |
|
|
88
|
+
| `ConversationContextInputs` | interface | `dist/core/actions.d.ts:513-520` | Option shapes | 2 field(s) |
|
|
89
|
+
| `conversationTrigger` | function | `dist/flow-sdk.d.ts:282-308` | 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:2481-2497` | Actions | Place an outgoing phone call (`uipath.conversational.voice.create-outgoing-call`) and get back the `callContext` every… |
|
|
91
|
+
| `CreateOutgoingCallInputs` | interface | `dist/core/actions.d.ts:592-600` | Option shapes | 2 field(s) |
|
|
92
|
+
| `CustomGuardrail` | interface | `dist/core/actions.d.ts:1217-1229` | Supporting types | A rule-based guardrail you author in place. |
|
|
93
|
+
| `dataFabricCreate` | function | `dist/nodes/data-fabric/flow/factories.d.ts:56-79` | Actions | Create an entity record in Data Fabric (`core.datafabric.create`). |
|
|
94
|
+
| `DataFabricCreateInputs` | interface | `dist/nodes/data-fabric/flow/spec.d.ts:129-159` | Option shapes | 4 field(s) |
|
|
95
|
+
| `dataFabricDelete` | function | `dist/nodes/data-fabric/flow/factories.d.ts:96-113` | Actions | Delete an entity record from Data Fabric (`core.datafabric.delete`). |
|
|
96
|
+
| `DataFabricDeleteInputs` | interface | `dist/nodes/data-fabric/flow/spec.d.ts:192-218` | Option shapes | 4 field(s) |
|
|
97
|
+
| `DataFabricFilter` | interface | `dist/nodes/data-fabric/flow/spec.d.ts:20-51` | Supporting types | One filter row on a Data Fabric query — rows AND together unless `or` is set. |
|
|
98
|
+
| `DataFabricOperator` | type | `dist/nodes/data-fabric/flow/spec.d.ts:9-19` | Supporting types | The comparison operators the Data Fabric query serializer can emit, spelled exactly as the file carries them. |
|
|
99
|
+
| `dataFabricRead` | function | `dist/nodes/data-fabric/flow/factories.d.ts:9-55` | Actions | Query entity records from Data Fabric (`core.datafabric.read`). |
|
|
100
|
+
| `DataFabricReadInputs` | interface | `dist/nodes/data-fabric/flow/spec.d.ts:76-128` | Option shapes | 9 field(s) |
|
|
101
|
+
| `DataFabricRecordRef` | type | `dist/nodes/data-fabric/flow/spec.d.ts:59-75` | Supporting types | Which record a Data Fabric write targets — exactly ONE of the two forms. |
|
|
102
|
+
| `DataFabricSort` | interface | `dist/nodes/data-fabric/flow/spec.d.ts:52-58` | Supporting types | How a multi-record query orders its rows before the limit is applied. |
|
|
103
|
+
| `dataFabricUpdate` | function | `dist/nodes/data-fabric/flow/factories.d.ts:80-95` | Actions | Update an entity record in Data Fabric (`core.datafabric.update`). |
|
|
104
|
+
| `DataFabricUpdateInputs` | interface | `dist/nodes/data-fabric/flow/spec.d.ts:160-191` | 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
|
-
| `DefinitionReference` | type | `dist/core/node-classes.d.ts:
|
|
107
|
-
| `delay` | function | `dist/
|
|
108
|
-
| `DELAY_PRESETS` | const | `dist/
|
|
109
|
-
| `DelayInputs` | type | `dist/
|
|
106
|
+
| `DefinitionReference` | type | `dist/core/node-classes.d.ts:34-67` | Supporting types | An exact reference to the node definition a contribution compiles against. |
|
|
107
|
+
| `delay` | function | `dist/nodes/delay/flow/factories.d.ts:7-28` | Actions | Declare a delay — a step that pauses the flow for a fixed length of time and then carries on. |
|
|
108
|
+
| `DELAY_PRESETS` | const | `dist/nodes/delay/flow/spec.d.ts:6-13` | Actions | The twelve durations the designer's dropdown offers. |
|
|
109
|
+
| `DelayInputs` | type | `dist/nodes/delay/flow/spec.d.ts:14-35` | 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/
|
|
112
|
-
| `DocumentClassifyInputs` | interface | `dist/
|
|
113
|
-
| `DocValidationInputs` | interface | `dist/core/actions.d.ts:
|
|
114
|
-
| `DoWhileOptions` | interface | `dist/flow-sdk.d.ts:
|
|
115
|
-
| `dynamicExtract` | function | `dist/
|
|
116
|
-
| `DynamicExtractInputs` | interface | `dist/
|
|
117
|
-
| `EdgeRoute` | interface | `dist/flow-sdk.d.ts:
|
|
118
|
-
| `endCall` | function | `dist/core/actions.d.ts:
|
|
119
|
-
| `EndCallInputs` | interface | `dist/core/actions.d.ts:
|
|
111
|
+
| `documentClassify` | function | `dist/nodes/document/flow/factories.d.ts:8-16` | Actions | Classify a document into a document type (`uipath.document.classify`). |
|
|
112
|
+
| `DocumentClassifyInputs` | interface | `dist/nodes/document/flow/spec.d.ts:9-18` | Option shapes | 4 field(s) |
|
|
113
|
+
| `DocValidationInputs` | interface | `dist/core/actions.d.ts:304-327` | Option shapes | The Document Validation task's subject — `variant: 'document-validation'` only. |
|
|
114
|
+
| `DoWhileOptions` | interface | `dist/flow-sdk.d.ts:457-466` | Option shapes | Do-while options. |
|
|
115
|
+
| `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… |
|
|
116
|
+
| `DynamicExtractInputs` | interface | `dist/nodes/document/flow/spec.d.ts:19-53` | Option shapes | 5 field(s) |
|
|
117
|
+
| `EdgeRoute` | interface | `dist/flow-sdk.d.ts:594-608` | Supporting types | One edge's route: user-dragged bends and/or the auto-router's waypoints. |
|
|
118
|
+
| `endCall` | function | `dist/core/actions.d.ts:2498-2505` | Actions | Hang up (`uipath.conversational.voice.end-call`). |
|
|
119
|
+
| `EndCallInputs` | interface | `dist/core/actions.d.ts:601-608` | 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-246` | 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:1809-1875` | 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:2795-2836` | Supporting types | One filter condition on the event payload. |
|
|
125
|
+
| `EventSubscription` | interface | `dist/core/actions.d.ts:2885-2926` | 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
|
-
| `FieldMapping` | interface | `dist/
|
|
128
|
-
| `FilterCondition` | type | `dist/
|
|
129
|
-
| `FilterMatch` | type | `dist/
|
|
130
|
-
| `FilterRule` | interface | `dist/
|
|
131
|
-
| `flow` | function | `dist/flow-sdk.d.ts:
|
|
132
|
-
| `FlowAction` | class | `dist/core/node-classes.d.ts:
|
|
133
|
-
| `FlowActionSpec` | type | `dist/flow-sdk.d.ts:
|
|
134
|
-
| `
|
|
135
|
-
| `
|
|
136
|
-
| `
|
|
137
|
-
| `
|
|
138
|
-
| `
|
|
139
|
-
| `
|
|
140
|
-
| `
|
|
141
|
-
| `
|
|
142
|
-
| `
|
|
143
|
-
| `
|
|
144
|
-
| `
|
|
145
|
-
| `
|
|
146
|
-
| `
|
|
147
|
-
| `
|
|
148
|
-
| `
|
|
149
|
-
| `
|
|
150
|
-
| `
|
|
151
|
-
| `
|
|
152
|
-
| `
|
|
153
|
-
| `
|
|
154
|
-
| `
|
|
155
|
-
| `
|
|
156
|
-
| `
|
|
157
|
-
| `
|
|
158
|
-
| `
|
|
159
|
-
| `
|
|
160
|
-
| `
|
|
161
|
-
| `
|
|
162
|
-
| `
|
|
163
|
-
| `
|
|
127
|
+
| `FieldMapping` | interface | `dist/nodes/transform/flow/spec.d.ts:27-34` | Supporting types | 3 field(s) |
|
|
128
|
+
| `FilterCondition` | type | `dist/nodes/transform/flow/spec.d.ts:10-11` | Supporting types | Comparison a filter rule applies to a field. |
|
|
129
|
+
| `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. |
|
|
130
|
+
| `FilterRule` | interface | `dist/nodes/transform/flow/spec.d.ts:12-24` | Supporting types | 3 field(s) |
|
|
131
|
+
| `flow` | function | `dist/flow-sdk.d.ts:1441-1456` | Flow construction | Start building a flow with the given id. |
|
|
132
|
+
| `FlowAction` | class | `dist/core/node-classes.d.ts:162-168` | Supporting types | A node placed as a step — pass an instance to `.step(name, …)`. |
|
|
133
|
+
| `FlowActionSpec` | type | `dist/flow-sdk.d.ts:48-49` | Supporting types | What `.step()` accepts here: the shared actions plus this SDK's subflow. |
|
|
134
|
+
| `FlowActionSpecs` | interface | `dist/core/actions.d.ts:1987-2096` | Supporting types | Every action kind, keyed by kind, to the body of its spec — the arm's fields other than `kind`. |
|
|
135
|
+
| `FlowBuilder` | class | `dist/flow-sdk.d.ts:1171-1440` | Builders | 13 member(s) |
|
|
136
|
+
| `FlowLayout` | interface | `dist/flow-sdk.d.ts:656-669` | Supporting types | Designer layout for a flow, keyed by AUTHOR-level ids: node entries by step name (plus the trigger id and `end`), edge… |
|
|
137
|
+
| `FlowNode` | class | `dist/core/node-classes.d.ts:126-161` | Supporting types | The abstract root of every definition-backed node the builder can place. |
|
|
138
|
+
| `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. |
|
|
139
|
+
| `FlowTrigger` | class | `dist/core/node-classes.d.ts:169-175` | Supporting types | A node that starts the flow — pass an instance to `.trigger(…)`. |
|
|
140
|
+
| `FormField` | type | `dist/core/actions.d.ts:243` | Supporting types | |
|
|
141
|
+
| `FormFieldType` | type | `dist/core/actions.d.ts:192-197` | Supporting types | A form field's type. |
|
|
142
|
+
| `formTrigger` | function | `dist/flow-sdk.d.ts:253-281` | Flow construction | Start the flow from a FORM a person fills in (`core.trigger.form`) — the platform renders one field per flow input and… |
|
|
143
|
+
| `GuardrailAction` | type | `dist/core/actions.d.ts:1206-1216` | Supporting types | What happens when a guardrail trips. |
|
|
144
|
+
| `GuardrailFieldReference` | interface | `dist/core/actions.d.ts:1173-1178` | Supporting types | A field the rule or filter action points at. |
|
|
145
|
+
| `GuardrailFieldSelector` | type | `dist/core/actions.d.ts:1179-1185` | Supporting types | All fields, or a named few. |
|
|
146
|
+
| `GuardrailRule` | type | `dist/core/actions.d.ts:1186-1205` | Supporting types | One condition of a custom guardrail. |
|
|
147
|
+
| `GuardrailScope` | type | `dist/core/actions.d.ts:1165-1166` | Supporting types | Where a guardrail applies: the whole agent, its LLM calls, or its tools. |
|
|
148
|
+
| `GuardrailSelector` | interface | `dist/core/actions.d.ts:1167-1172` | Supporting types | Which artifacts inside the scope the guardrail watches. |
|
|
149
|
+
| `hitl` | function | `dist/core/actions.d.ts:2142-2193` | 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… |
|
|
150
|
+
| `HitlAssigneeType` | type | `dist/core/actions.d.ts:250-257` | Supporting types | How the task is assigned, the platform's own vocabulary (canvas `HITL_ASSIGNEE_TYPE`): `'user'` a single user, `'group'`… |
|
|
151
|
+
| `HitlChannel` | type | `dist/core/actions.d.ts:244-249` | Supporting types | Where the task is delivered. |
|
|
152
|
+
| `HitlConnection` | interface | `dist/core/actions.d.ts:258-266` | Supporting types | A per-channel Integration Service connection (Slack / Teams delivery). |
|
|
153
|
+
| `HitlInputs` | interface | `dist/core/actions.d.ts:412-483` | Option shapes | 11 field(s) |
|
|
154
|
+
| `HitlRecipient` | interface | `dist/core/actions.d.ts:267-303` | Supporting types | Who gets the task and over which channels. |
|
|
155
|
+
| `HitlVariant` | type | `dist/core/actions.d.ts:340-365` | Supporting types | WHICH human-task node type to emit. |
|
|
156
|
+
| `http` | function | `dist/core/actions.d.ts:2134-2141` | Actions | Declare an HTTP request action, explicitly choosing standalone or managed. |
|
|
157
|
+
| `HttpBranch` | interface | `dist/core/actions.d.ts:13-28` | Supporting types | One conditional response branch on an HTTP node — a designer-visible side exit. |
|
|
158
|
+
| `HttpInputs` | type | `dist/core/actions.d.ts:130-147` | Option shapes | |
|
|
159
|
+
| `HttpInputsBase` | interface | `dist/core/actions.d.ts:29-129` | Option shapes | 11 field(s) |
|
|
160
|
+
| `HttpRequestToolRef` | interface | `dist/core/actions.d.ts:1612-1641` | Supporting types | The built-in HTTP-request tool (`uipath.agent.resource.tool.builtin.httprequest`): the agent performs an HTTP call. |
|
|
161
|
+
| `inlineAgent` | function | `dist/core/actions.d.ts:2657-2707` | Actions | Declare an INLINE AUTONOMOUS AGENT — an agent defined inside this flow's own project rather than published to… |
|
|
162
|
+
| `InlineAgentFieldType` | type | `dist/core/actions.d.ts:1145-1146` | Supporting types | A JSON-schema-ish type for one field of an inline agent's input/output schema. |
|
|
163
|
+
| `InlineAgentInputs` | interface | `dist/core/actions.d.ts:1273-1533` | Option shapes | 16 field(s) |
|
|
164
|
+
| `InOutField` | interface | `dist/core/actions.d.ts:225-242` | Supporting types | A value the reviewer READS **and can correct**: pre-filled from the flow, editable on the form, and the (possibly… |
|
|
164
165
|
| `input` | function | `dist/core/expr.d.ts:44-61` | Expressions and types | Reference a flow input by name → `$vars.<triggerId>.output.<name>`. |
|
|
165
166
|
| `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:
|
|
167
|
-
| `IxpExtractInputs` | interface | `dist/core/actions.d.ts:
|
|
168
|
-
| `IxpToolRef` | interface | `dist/core/actions.d.ts:
|
|
167
|
+
| `ixpExtract` | function | `dist/core/actions.d.ts:2270-2324` | Actions | Extract fields from a document with a published IxP project — the platform's **Extract** node (`uipath.ixp.*`, service… |
|
|
168
|
+
| `IxpExtractInputs` | interface | `dist/core/actions.d.ts:739-813` | Option shapes | 9 field(s) |
|
|
169
|
+
| `IxpToolRef` | interface | `dist/core/actions.d.ts:1770-1808` | Supporting types | A published IxP (Intelligent eXtraction Platform) project as a tool — the agent decides when to extract a document and… |
|
|
169
170
|
| `js` | function | `dist/core/expr.d.ts:247-282` | Expressions and types | Build a raw JS *expression* (a condition or computation). |
|
|
170
171
|
| `lit` | function | `dist/core/expr.d.ts:22-28` | Expressions and types | A constant value baked directly into a node input. |
|
|
171
172
|
| `lookup` | function | `dist/core/lookups.d.ts:95-102` | Generated descriptors | Begin resolving a lookup field on a generated descriptor. |
|
|
@@ -180,85 +181,85 @@ could hand you spans for a version you do not have.
|
|
|
180
181
|
| `lookupSpecOf` | function | `dist/core/lookups.d.ts:199-206` | Generated descriptors | The LookupSpec for one field, or `undefined` when it earns no helper. |
|
|
181
182
|
| `LookupStrategy` | type | `dist/core/lookups.d.ts:1-10` | Generated descriptors | How `prepare` should retrieve the collection, chosen from the metadata. |
|
|
182
183
|
| `LookupToken` | interface | `dist/core/lookups.d.ts:37-52` | Generated descriptors | An unresolved lookup: what `.byEmail(…)` returns. |
|
|
183
|
-
| `LoopOptions` | interface | `dist/flow-sdk.d.ts:
|
|
184
|
-
| `manual` | function | `dist/flow-sdk.d.ts:
|
|
185
|
-
| `McpToolRef` | interface | `dist/core/actions.d.ts:
|
|
186
|
-
| `mock` | function | `dist/
|
|
187
|
-
| `NodeContribution` | interface | `dist/core/node-classes.d.ts:
|
|
188
|
-
| `NodeLayout` | interface | `dist/flow-sdk.d.ts:
|
|
189
|
-
| `NodeOptions` | interface | `dist/flow-sdk.d.ts:
|
|
190
|
-
| `onEvent` | function | `dist/flow-sdk.d.ts:
|
|
191
|
-
| `onEvent` | function | `dist/flow-sdk.d.ts:
|
|
184
|
+
| `LoopOptions` | interface | `dist/flow-sdk.d.ts:436-456` | Option shapes | Loop-specific options. |
|
|
185
|
+
| `manual` | function | `dist/flow-sdk.d.ts:176-185` | Flow construction | The manual trigger, explicitly. |
|
|
186
|
+
| `McpToolRef` | interface | `dist/core/actions.d.ts:1546-1574` | Supporting types | An MCP server the agent may call tools on. |
|
|
187
|
+
| `mock` | function | `dist/nodes/mock/flow/factories.d.ts:6-45` | Actions | Declare a PLACEHOLDER step — "a real node goes here later". |
|
|
188
|
+
| `NodeContribution` | interface | `dist/core/node-classes.d.ts:102-125` | Supporting types | One validated construct, returned by FlowNode.contribute. |
|
|
189
|
+
| `NodeLayout` | interface | `dist/flow-sdk.d.ts:579-593` | Supporting types | One node's designer layout: canvas position, and optionally size and collapsed state. |
|
|
190
|
+
| `NodeOptions` | interface | `dist/flow-sdk.d.ts:355-403` | Option shapes | Options shared by every builder method that creates a definition-backed node: `version` selects the exact node… |
|
|
191
|
+
| `onEvent` | function | `dist/flow-sdk.d.ts:186-224` | Flow construction | Start the flow when a connector event fires — e.g. an email arriving in a mailbox folder. |
|
|
192
|
+
| `onEvent` | function | `dist/flow-sdk.d.ts:225-232` | Flow construction | Stringly form, for an event with no prepared module. |
|
|
192
193
|
| `out` | function | `dist/core/expr.d.ts:73-94` | Expressions and types | Reference an upstream step's output → `$vars.<step>.output[.<path>]`. |
|
|
193
|
-
| `Outcome` | type | `dist/core/actions.d.ts:
|
|
194
|
-
| `OutputColumn` | interface | `dist/core/actions.d.ts:
|
|
195
|
-
| `PortArm` | interface | `dist/flow-sdk.d.ts:
|
|
196
|
-
| `ProcessLocation` | type | `dist/core/actions.d.ts:
|
|
197
|
-
| `ProcessToolKind` | type | `dist/core/actions.d.ts:
|
|
198
|
-
| `ProcessToolRef` | interface | `dist/core/actions.d.ts:
|
|
199
|
-
| `publishedFunction` | function | `dist/core/actions.d.ts:
|
|
200
|
-
| `PublishedFunctionInputs` | interface | `dist/core/actions.d.ts:
|
|
201
|
-
| `queueItem` | function | `dist/core/actions.d.ts:
|
|
202
|
-
| `QueueItemInputs` | interface | `dist/core/actions.d.ts:
|
|
203
|
-
| `QueuePriority` | type | `dist/core/actions.d.ts:
|
|
194
|
+
| `Outcome` | type | `dist/core/actions.d.ts:328-339` | Supporting types | One completion button. |
|
|
195
|
+
| `OutputColumn` | interface | `dist/core/actions.d.ts:699-705` | Supporting types | One column Batch Transform appends to the CSV. |
|
|
196
|
+
| `PortArm` | interface | `dist/flow-sdk.d.ts:342-354` | Supporting types | One arm of a built `.stepSwitch` — the same shape as SwitchArm, but `value` names an exit the ACTION declares (a… |
|
|
197
|
+
| `ProcessLocation` | type | `dist/core/actions.d.ts:814-819` | Supporting types | Where a process resource lives: deployed to an Orchestrator folder (`'published'`, the default) or a sibling project of… |
|
|
198
|
+
| `ProcessToolKind` | type | `dist/core/actions.d.ts:1726-1739` | Supporting types | The tool kinds that wrap a DEPLOYED tenant resource. |
|
|
199
|
+
| `ProcessToolRef` | interface | `dist/core/actions.d.ts:1740-1769` | Supporting types | A deployed tenant resource the agent may invoke. |
|
|
200
|
+
| `publishedFunction` | function | `dist/core/actions.d.ts:2405-2429` | Actions | Invoke a published Orchestrator **Function** — a deployed unit of code run as one step (`uipath.core.function.<key>`,… |
|
|
201
|
+
| `PublishedFunctionInputs` | interface | `dist/core/actions.d.ts:911-945` | Option shapes | A published Orchestrator **Function** — a small, single-purpose unit of code deployed as its own resource and invoked as… |
|
|
202
|
+
| `queueItem` | function | `dist/core/actions.d.ts:2708-2753` | Actions | Declare an Orchestrator QUEUE ITEM step. |
|
|
203
|
+
| `QueueItemInputs` | interface | `dist/core/actions.d.ts:1913-1986` | Option shapes | 10 field(s) |
|
|
204
|
+
| `QueuePriority` | type | `dist/core/actions.d.ts:1911-1912` | Supporting types | The three priorities an Orchestrator queue item can carry. |
|
|
204
205
|
| `ran` | function | `dist/core/expr.d.ts:95-141` | Expressions and types | Did this step run? |
|
|
205
|
-
| `rawNode` | function | `dist/
|
|
206
|
+
| `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… |
|
|
206
207
|
| `RawReference` | type | `dist/core/lookups.d.ts:190-198` | Supporting types | |
|
|
207
|
-
| `RemoteA2aToolRef` | interface | `dist/core/actions.d.ts:
|
|
208
|
+
| `RemoteA2aToolRef` | interface | `dist/core/actions.d.ts:1575-1595` | Supporting types | A remote A2A (agent-to-agent) endpoint the agent may delegate to. |
|
|
208
209
|
| `resolvedValue` | function | `dist/core/lookups.d.ts:172-179` | Generated descriptors | The recorded id for a token, or `undefined`. |
|
|
209
210
|
| `resolveEventWhere` | function | `dist/core/lookups.d.ts:207-224` | Generated descriptors | An event subscription's `where` with every lookup token swapped for the id `registry prepare --resolve` recorded, or a… |
|
|
210
|
-
| `ReturnFieldType` | type | `dist/core/actions.d.ts:
|
|
211
|
-
| `ReturnOptions` | interface | `dist/flow-sdk.d.ts:
|
|
212
|
-
| `rpaWorkflow` | function | `dist/core/actions.d.ts:
|
|
213
|
-
| `RpaWorkflowInputs` | interface | `dist/core/actions.d.ts:
|
|
214
|
-
| `SCHEDULE_PRESETS` | const | `dist/flow-sdk.d.ts:
|
|
215
|
-
| `scheduled` | function | `dist/flow-sdk.d.ts:
|
|
216
|
-
| `ScheduledInputs` | interface | `dist/flow-sdk.d.ts:
|
|
217
|
-
| `ScheduleEvery` | type | `dist/flow-sdk.d.ts:
|
|
218
|
-
| `SchedulePreset` | type | `dist/flow-sdk.d.ts:
|
|
219
|
-
| `script` | function | `dist/
|
|
220
|
-
| `ScriptInputs` | interface | `dist/
|
|
211
|
+
| `ReturnFieldType` | type | `dist/core/actions.d.ts:1147-1164` | Supporting types | A JSON-schema-ish type for one field of a step's declared `returns`. |
|
|
212
|
+
| `ReturnOptions` | interface | `dist/flow-sdk.d.ts:404-435` | Option shapes | `.return(...)`-specific options. |
|
|
213
|
+
| `rpaWorkflow` | function | `dist/core/actions.d.ts:2325-2369` | Actions | Invoke a deployed RPA (robotic process automation) workflow — a classic UI-automation process, published to… |
|
|
214
|
+
| `RpaWorkflowInputs` | interface | `dist/core/actions.d.ts:820-878` | Option shapes | 7 field(s) |
|
|
215
|
+
| `SCHEDULE_PRESETS` | const | `dist/flow-sdk.d.ts:123-130` | Flow construction | The eight intervals the designer offers in its Frequency dropdown. |
|
|
216
|
+
| `scheduled` | function | `dist/flow-sdk.d.ts:233-252` | Flow construction | Start the flow on a recurring schedule instead of on demand. |
|
|
217
|
+
| `ScheduledInputs` | interface | `dist/flow-sdk.d.ts:144-156` | Option shapes | 1 field(s) |
|
|
218
|
+
| `ScheduleEvery` | type | `dist/flow-sdk.d.ts:132-143` | Supporting types | How often a scheduled flow runs, as an ISO-8601 repeating interval: `R/` followed by a duration. |
|
|
219
|
+
| `SchedulePreset` | type | `dist/flow-sdk.d.ts:131` | Supporting types | |
|
|
220
|
+
| `script` | function | `dist/nodes/script/flow/factories.d.ts:7-14` | Actions | Declare an inline script action. |
|
|
221
|
+
| `ScriptInputs` | interface | `dist/nodes/script/flow/spec.d.ts:7-44` | Option shapes | 2 field(s) |
|
|
221
222
|
| `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… |
|
|
222
223
|
| `ScriptReturnType` | type | `dist/core/script-return.d.ts:31-32` | Supporting types | The vocabulary a script's output can be declared as. |
|
|
223
|
-
| `sendMessage` | function | `dist/core/actions.d.ts:
|
|
224
|
-
| `SendMessageInputs` | interface | `dist/core/actions.d.ts:
|
|
225
|
-
| `ShownField` | interface | `dist/core/actions.d.ts:
|
|
226
|
-
| `Step` | type | `dist/flow-sdk.d.ts:
|
|
227
|
-
| `StepList` | class | `dist/flow-sdk.d.ts:
|
|
228
|
-
| `STICKY_NOTE_COLORS` | const | `dist/flow-sdk.d.ts:
|
|
229
|
-
| `StickyNote` | interface | `dist/flow-sdk.d.ts:
|
|
230
|
-
| `StickyNoteColor` | type | `dist/flow-sdk.d.ts:
|
|
231
|
-
| `subflow` | function | `dist/flow-sdk.d.ts:
|
|
232
|
-
| `SubflowSpec` | interface | `dist/flow-sdk.d.ts:
|
|
233
|
-
| `summarize` | function | `dist/core/actions.d.ts:
|
|
234
|
-
| `SummarizeInputs` | interface | `dist/core/actions.d.ts:
|
|
235
|
-
| `SwitchArm` | interface | `dist/flow-sdk.d.ts:
|
|
224
|
+
| `sendMessage` | function | `dist/core/actions.d.ts:2430-2448` | Actions | Post an assistant message into a live conversation (`uipath.conversational.send-message`). |
|
|
225
|
+
| `SendMessageInputs` | interface | `dist/core/actions.d.ts:484-503` | Option shapes | 4 field(s) |
|
|
226
|
+
| `ShownField` | interface | `dist/core/actions.d.ts:198-213` | Supporting types | A value the reviewer READS: shown on the form, filled in from the flow. |
|
|
227
|
+
| `Step` | type | `dist/flow-sdk.d.ts:467-578` | Supporting types | |
|
|
228
|
+
| `StepList` | class | `dist/flow-sdk.d.ts:719-1146` | Builders | Collects a sequence of steps. |
|
|
229
|
+
| `STICKY_NOTE_COLORS` | const | `dist/flow-sdk.d.ts:609-614` | Flow construction | The designer's sticky-note palette. |
|
|
230
|
+
| `StickyNote` | interface | `dist/flow-sdk.d.ts:621-655` | Supporting types | A canvas sticky note — free text pinned to the diagram, for the humans reading it. |
|
|
231
|
+
| `StickyNoteColor` | type | `dist/flow-sdk.d.ts:615-620` | Supporting types | A sticky note's swatch. |
|
|
232
|
+
| `subflow` | function | `dist/flow-sdk.d.ts:1457-1496` | Flow construction | Run another flow as one step, and read back what it returns. |
|
|
233
|
+
| `SubflowSpec` | interface | `dist/flow-sdk.d.ts:40-47` | Supporting types | A step that runs a child flow. |
|
|
234
|
+
| `summarize` | function | `dist/core/actions.d.ts:2194-2234` | Actions | Summarize a document with citations — the platform's **Summarize** node. |
|
|
235
|
+
| `SummarizeInputs` | interface | `dist/core/actions.d.ts:666-698` | Option shapes | 3 field(s) |
|
|
236
|
+
| `SwitchArm` | interface | `dist/flow-sdk.d.ts:336-341` | Supporting types | One arm of a built `.switch` (the serializer's view: body already collected). |
|
|
236
237
|
| `tmpl` | function | `dist/core/expr.d.ts:283-293` | Expressions and types | Build a JS *string template* (for URLs, messages, etc.). |
|
|
237
|
-
| `ToolRef` | type | `dist/core/actions.d.ts:
|
|
238
|
-
| `transform` | function | `dist/
|
|
239
|
-
| `Transformation` | type | `dist/
|
|
240
|
-
| `TransformInputs` | interface | `dist/
|
|
241
|
-
| `TransformOperation` | type | `dist/
|
|
242
|
-
| `TransformVariant` | type | `dist/
|
|
238
|
+
| `ToolRef` | type | `dist/core/actions.d.ts:1536-1545` | Supporting types | One tool on an inline agent — a discriminated union over the kinds the tenant's registry actually serves… |
|
|
239
|
+
| `transform` | function | `dist/nodes/transform/flow/factories.d.ts:7-52` | Actions | Declare a Transform action — a chain of declarative operations over a collection. |
|
|
240
|
+
| `Transformation` | type | `dist/nodes/transform/flow/spec.d.ts:25-26` | Supporting types | What a map does to a field's value. |
|
|
241
|
+
| `TransformInputs` | interface | `dist/nodes/transform/flow/spec.d.ts:84-108` | Option shapes | 3 field(s) |
|
|
242
|
+
| `TransformOperation` | type | `dist/nodes/transform/flow/spec.d.ts:43-60` | Supporting types | One link in the chain. |
|
|
243
|
+
| `TransformVariant` | type | `dist/nodes/transform/flow/spec.d.ts:61-77` | Supporting types | Which Transform node type to emit. |
|
|
243
244
|
| `triggerDescriptor` | function | `dist/core/connectors.d.ts:139-151` | Generated descriptors | Brand a trigger descriptor literal with its where/output types. |
|
|
244
245
|
| `TriggerDescriptor` | type | `dist/core/connectors.d.ts:130-138` | Generated descriptors | A generated, typed connector-trigger descriptor: TriggerMeta branded with phantom `where`/output types. |
|
|
245
246
|
| `TriggerMeta` | interface | `dist/core/connectors.d.ts:120-129` | Generated descriptors | Runtime metadata a generated trigger descriptor carries. |
|
|
246
|
-
| `TriggerOptions` | interface | `dist/core/actions.d.ts:
|
|
247
|
-
| `TriggerSpec` | type | `dist/flow-sdk.d.ts:
|
|
247
|
+
| `TriggerOptions` | interface | `dist/core/actions.d.ts:2837-2884` | Option shapes | The typed `onEvent`/`waitForEvent` options — everything an EventSubscription carries except `connector`/`event`, which… |
|
|
248
|
+
| `TriggerSpec` | type | `dist/flow-sdk.d.ts:157-175` | Supporting types | What starts the flow. |
|
|
248
249
|
| `TypeDesc` | type | `dist/core/expr.d.ts:385` | Supporting types | |
|
|
249
250
|
| `types` | const | `dist/core/expr.d.ts:369-384` | Expressions and types | Variable type descriptors (map to Flow variable `type` values). |
|
|
250
251
|
| `unresolvedLookupMessage` | function | `dist/core/lookups.d.ts:180-189` | Generated descriptors | The message for a lookup nothing has resolved — the command that fixes it. |
|
|
251
252
|
| `v` | function | `dist/core/expr.d.ts:29-41` | Expressions and types | Reference a flow variable or output by name → `$vars.<name>`. |
|
|
252
|
-
| `VarDecl` | interface | `dist/flow-sdk.d.ts:
|
|
253
|
-
| `VarSpec` | interface | `dist/flow-sdk.d.ts:
|
|
254
|
-
| `voiceAgent` | function | `dist/core/actions.d.ts:
|
|
255
|
-
| `VoiceAgentInputs` | interface | `dist/core/actions.d.ts:
|
|
256
|
-
| `VoiceSettings` | interface | `dist/core/actions.d.ts:
|
|
257
|
-
| `voiceTrigger` | function | `dist/flow-sdk.d.ts:
|
|
258
|
-
| `waitForEvent` | function | `dist/core/actions.d.ts:
|
|
259
|
-
| `waitForEvent` | function | `dist/core/actions.d.ts:
|
|
260
|
-
| `waitForMessage` | function | `dist/core/actions.d.ts:
|
|
261
|
-
| `WaitForMessageInputs` | interface | `dist/core/actions.d.ts:
|
|
253
|
+
| `VarDecl` | interface | `dist/flow-sdk.d.ts:54-66` | Supporting types | 7 field(s) |
|
|
254
|
+
| `VarSpec` | interface | `dist/flow-sdk.d.ts:67-122` | Supporting types | The rich spelling of a variable declaration: pass it instead of a bare `types.*` descriptor wherever `.input()` /… |
|
|
255
|
+
| `voiceAgent` | function | `dist/core/actions.d.ts:2506-2530` | Actions | Put a VOICE agent on a live call (`uipath.agent.voice`) — it speaks and listens for one turn, then the flow continues. |
|
|
256
|
+
| `VoiceAgentInputs` | interface | `dist/core/actions.d.ts:632-665` | Option shapes | 6 field(s) |
|
|
257
|
+
| `VoiceSettings` | interface | `dist/core/actions.d.ts:609-631` | Supporting types | The audio settings a voice agent speaks with. |
|
|
258
|
+
| `voiceTrigger` | function | `dist/flow-sdk.d.ts:309-333` | Flow construction | Start the flow when a phone call comes IN (`core.trigger.voice`). |
|
|
259
|
+
| `waitForEvent` | function | `dist/core/actions.d.ts:2936-2971` | Actions | Wait mid-flow until a connector event fires, then continue with its payload — the typed form, where a generated trigger… |
|
|
260
|
+
| `waitForEvent` | function | `dist/core/actions.d.ts:2972-2979` | Actions | Stringly form, for an event with no prepared module. |
|
|
261
|
+
| `waitForMessage` | function | `dist/core/actions.d.ts:2449-2465` | Actions | PAUSE until the person sends their next message (`uipath.conversational.wait-for-message`) — a catch event, like… |
|
|
262
|
+
| `WaitForMessageInputs` | interface | `dist/core/actions.d.ts:504-512` | Option shapes | 2 field(s) |
|
|
262
263
|
|
|
263
264
|
## `@uipath/maestro-builder-sdk/case`
|
|
264
265
|
|
|
@@ -293,15 +294,15 @@ could hand you spans for a version you do not have.
|
|
|
293
294
|
| `CaseVarDecl` | interface | `dist/case/case-sdk.d.ts:557-571` | Supporting types | 6 field(s) |
|
|
294
295
|
| `ConnectorDescriptor` | type | `dist/core/connectors.d.ts:89-97` | Supporting types | A generated, typed connector descriptor: ConnectorMeta branded with phantom input/output types. |
|
|
295
296
|
| `ConnectorMeta` | interface | `dist/core/connectors.d.ts:60-88` | Supporting types | Runtime metadata a generated descriptor carries. |
|
|
296
|
-
| `ConnectorOpts` | interface | `dist/core/actions.d.ts:
|
|
297
|
+
| `ConnectorOpts` | interface | `dist/core/actions.d.ts:148-191` | Option shapes | 4 field(s) |
|
|
297
298
|
| `ConnectorSpecData` | type | `dist/case/case-sdk.d.ts:376-388` | Supporting types | An Integration Service connector task — the connector variant of the shared `ActionSpec`. |
|
|
298
299
|
| `EntryOpts` | interface | `dist/case/case-sdk.d.ts:649-661` | Option shapes | Options common to a stage/task entry condition. |
|
|
299
300
|
| `escalation` | function | `dist/case/case-sdk.d.ts:143-149` | Case authoring | Declare an escalation. |
|
|
300
301
|
| `EscalationOpts` | interface | `dist/case/case-sdk.d.ts:127-139` | Option shapes | 4 field(s) |
|
|
301
302
|
| `EscalationRecipient` | interface | `dist/case/case-sdk.d.ts:119-126` | Supporting types | Who an escalation notifies. |
|
|
302
303
|
| `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`). |
|
|
303
|
-
| `EventFilter` | type | `dist/core/actions.d.ts:
|
|
304
|
-
| `EventSubscription` | interface | `dist/core/actions.d.ts:
|
|
304
|
+
| `EventFilter` | type | `dist/core/actions.d.ts:2795-2836` | Supporting types | One filter condition on the event payload. |
|
|
305
|
+
| `EventSubscription` | interface | `dist/core/actions.d.ts:2885-2926` | Option shapes | What a connector event subscribes to. |
|
|
305
306
|
| `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. |
|
|
306
307
|
| `eventTrigger` | function | `dist/case/case-sdk.d.ts:287-293` | Case authoring | An Integration Service event trigger in placeholder or stringly-resolved form. |
|
|
307
308
|
| `EventTriggerOpts` | interface | `dist/case/case-sdk.d.ts:239-263` | Option shapes | 4 field(s) |
|
|
@@ -337,7 +338,7 @@ could hand you spans for a version you do not have.
|
|
|
337
338
|
| `toUser` | function | `dist/case/case-sdk.d.ts:150-157` | Case authoring | An escalation recipient that is a single user. |
|
|
338
339
|
| `TriggerDescriptor` | type | `dist/core/connectors.d.ts:130-138` | Supporting types | A generated, typed connector-trigger descriptor: TriggerMeta branded with phantom `where`/output types. |
|
|
339
340
|
| `TriggerMeta` | interface | `dist/core/connectors.d.ts:120-129` | Supporting types | Runtime metadata a generated trigger descriptor carries. |
|
|
340
|
-
| `TriggerOptions` | interface | `dist/core/actions.d.ts:
|
|
341
|
+
| `TriggerOptions` | interface | `dist/core/actions.d.ts:2837-2884` | Option shapes | The typed `onEvent`/`waitForEvent` options — everything an EventSubscription carries except `connector`/`event`, which… |
|
|
341
342
|
| `TypeDesc` | type | `dist/core/expr.d.ts:385` | Supporting types | |
|
|
342
343
|
| `UnresolvedReferenceTaskKind` | type | `dist/case/case-sdk.d.ts:358-359` | Supporting types | Published-resource task kinds that the Case schema permits as unresolved skeletons. |
|
|
343
344
|
| `WaitConnectorPlaceholderSpec` | interface | `dist/case/case-sdk.d.ts:360-370` | Supporting types | A `wait-for-connector` subscription: suspend on an Integration Service event. |
|
|
@@ -376,7 +377,7 @@ could hand you spans for a version you do not have.
|
|
|
376
377
|
| `ConnectorDescriptor` | type | `dist/core/connectors.d.ts:89-97` | Supporting types | A generated, typed connector descriptor: ConnectorMeta branded with phantom input/output types. |
|
|
377
378
|
| `ConnectorEventOpts` | interface | `dist/bpmn/bpmn-sdk.d.ts:1417-1496` | Option shapes | Shared options for the two connector-event methods. |
|
|
378
379
|
| `ConnectorMeta` | interface | `dist/core/connectors.d.ts:60-88` | Supporting types | Runtime metadata a generated descriptor carries. |
|
|
379
|
-
| `ConnectorOpts` | interface | `dist/core/actions.d.ts:
|
|
380
|
+
| `ConnectorOpts` | interface | `dist/core/actions.d.ts:148-191` | Option shapes | 4 field(s) |
|
|
380
381
|
| `DataServiceOperation` | type | `dist/bpmn/data-service.d.ts:39-115` | Supporting types | The operation half of DataServiceOpts — one of eight, discriminated on `op`. |
|
|
381
382
|
| `DataServiceOpts` | interface | `dist/bpmn/bpmn-sdk.d.ts:1074-1122` | Option shapes | Options for `.dataService()` — one UiPath Data Fabric (Data Service) record or file operation. |
|
|
382
383
|
| `DefinitionsRegistry` | class | `dist/bpmn/bpmn-sdk.d.ts:2004-2027` | Supporting types | Collects definitions-level message/error declarations, de-duped by name. |
|
|
@@ -388,7 +389,7 @@ could hand you spans for a version you do not have.
|
|
|
388
389
|
| `errorSchema` | const | `dist/bpmn/bpmn-sdk.d.ts:3490-3531` | BPMN authoring | The `Error` variable's shape — the platform's own error envelope. |
|
|
389
390
|
| `errorSchemaWithResponse` | const | `dist/bpmn/bpmn-sdk.d.ts:3532-3564` | BPMN authoring | The same envelope plus `response` — what a node whose failure carries a payload writes, and what the same source calls… |
|
|
390
391
|
| `EventDef` | type | `dist/bpmn/bpmn-sdk.d.ts:54-72` | Supporting types | The resolved event definition attached to an event node. |
|
|
391
|
-
| `EventFilter` | type | `dist/core/actions.d.ts:
|
|
392
|
+
| `EventFilter` | type | `dist/core/actions.d.ts:2795-2836` | Supporting types | One filter condition on the event payload. |
|
|
392
393
|
| `EventKind` | type | `dist/bpmn/bpmn-sdk.d.ts:75-76` | Supporting types | The four non-boundary event element kinds a BpmnNode can be. |
|
|
393
394
|
| `EventSubProcessOpts` | interface | `dist/bpmn/bpmn-sdk.d.ts:1835-1895` | Option shapes | Options for ScopeBuilder.eventSubProcess. |
|
|
394
395
|
| `ExtensionPayload` | interface | `dist/bpmn/bpmn-sdk.d.ts:557-593` | Supporting types | An extension payload carried by an element the payload does not describe. |
|