@uipath/maestro-builder-sdk 6.15.4 → 6.15.6
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/README.md +3 -1
- package/dist/api-index.md +122 -121
- package/dist/api-members.md +410 -405
- package/dist/bpmn/bpmn-sdk.d.ts +170 -18
- package/dist/bpmn/bpmn-sdk.js +123 -5
- package/dist/bpmn/check-cli.js +4 -3
- package/dist/bpmn/check.js +79 -6
- package/dist/bpmn/connector.js +5 -2
- package/dist/bpmn/data-service.d.ts +10 -2
- package/dist/bpmn/data-service.js +10 -1
- package/dist/bpmn/decompile.js +13 -2
- package/dist/bpmn/intsvc.d.ts +8 -0
- package/dist/bpmn/intsvc.js +43 -2
- package/dist/bpmn/serialize.d.ts +14 -0
- package/dist/bpmn/serialize.js +38 -9
- package/dist/bpmn/typed-node.js +76 -4
- package/dist/check.js +142 -6
- package/dist/cli-result.d.ts +14 -0
- package/dist/cli-result.js +18 -0
- package/dist/core/connector-inputs.d.ts +20 -0
- package/dist/core/connector-inputs.js +51 -0
- package/dist/core/event-checks.d.ts +8 -6
- package/dist/core/event-checks.js +8 -6
- package/dist/core/expr.d.ts +8 -2
- package/dist/core/expr.js +8 -2
- package/dist/core/global-names.d.ts +5 -7
- package/dist/core/global-names.js +5 -14
- package/dist/decompile.js +2 -2
- package/dist/flow-sdk.d.ts +27 -4
- package/dist/flow-sdk.js +24 -7
- package/dist/flow-variables.d.ts +66 -0
- package/dist/flow-variables.js +84 -0
- package/dist/registry/path-cli.js +3 -3
- package/dist/registry/search-cli.js +2 -2
- package/dist/serialize.js +27 -17
- package/package.json +2 -2
package/README.md
CHANGED
|
@@ -202,7 +202,9 @@ $ npx flow-sdk flow compile Hello -o Hello.flow --json
|
|
|
202
202
|
```
|
|
203
203
|
|
|
204
204
|
`check` reports `errors`, `warnings` and `diagnostics`; `compile`, `decompile`,
|
|
205
|
-
`merge` and `tidy` report the `path` they wrote.
|
|
205
|
+
`merge` and `tidy` report the `path` they wrote. A verb whose plain output is the
|
|
206
|
+
result itself (`registry search`, `registry path`, `bpmn check --graph`) prints it
|
|
207
|
+
only as that object under `--json`, never a second copy on stderr. `package.json` lists the optional
|
|
206
208
|
surface a caller may probe for in `cliCapabilities` (`json-result`).
|
|
207
209
|
|
|
208
210
|
The stable argv grammar is family first: `flow|case|bpmn`, then the SDK verb and
|
package/dist/api-index.md
CHANGED
|
@@ -57,17 +57,17 @@ could hand you spans for a version you do not have.
|
|
|
57
57
|
| `apiWorkflow` | function | `dist/core/actions.d.ts:2811-2845` | 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
|
-
| `ArmBuilder` | class | `dist/flow-sdk.d.ts:
|
|
60
|
+
| `ArmBuilder` | class | `dist/flow-sdk.d.ts:1097-1120` | 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
62
|
| `batchTransform` | function | `dist/core/actions.d.ts:2614-2648` | 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
|
-
| `BuiltEntryPoint` | interface | `dist/flow-sdk.d.ts:
|
|
66
|
-
| `BuiltFlow` | interface | `dist/flow-sdk.d.ts:
|
|
65
|
+
| `BuiltEntryPoint` | interface | `dist/flow-sdk.d.ts:625-637` | Supporting types | One additional flow root, built by `.entryPoint()`. |
|
|
66
|
+
| `BuiltFlow` | interface | `dist/flow-sdk.d.ts:638-673` | Supporting types | 15 field(s) |
|
|
67
67
|
| `BuiltinToolName` | type | `dist/core/actions.d.ts:1641-1642` | Supporting types | The three platform-shipped built-in tools (fixed registry types). |
|
|
68
68
|
| `BuiltinToolRef` | interface | `dist/core/actions.d.ts:1774-1794` | 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
|
-
| `CaseValue` | type | `dist/flow-sdk.d.ts:
|
|
70
|
+
| `CaseValue` | type | `dist/flow-sdk.d.ts:292-293` | Supporting types | A value a `.switch` case compares the discriminant against. |
|
|
71
71
|
| `ChildFlow` | type | `dist/flow-sdk.d.ts:43-46` | Supporting types | Anything `subflow()` accepts as the child: a builder, or an already-built flow. |
|
|
72
72
|
| `ClientSideToolRef` | interface | `dist/core/actions.d.ts:1703-1718` | Supporting types | A CLIENT-side tool: the agent asks the CALLING application to run it and hand the answer back… |
|
|
73
73
|
| `connector` | function | `dist/core/actions.d.ts:3306-3329` | Actions | Declare an Integration Service connector action — the typed form, where a generated descriptor supplies the nodeType and… |
|
|
@@ -86,7 +86,7 @@ could hand you spans for a version you do not have.
|
|
|
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
87
|
| `conversationContext` | function | `dist/core/actions.d.ts:2907-2921` | 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
|
-
| `conversationTrigger` | function | `dist/flow-sdk.d.ts:
|
|
89
|
+
| `conversationTrigger` | function | `dist/flow-sdk.d.ts:240-266` | Flow construction | Start the flow when a new CONVERSATION is created (`core.trigger.conversation`) — the entry point for a chat-driven… |
|
|
90
90
|
| `createOutgoingCall` | function | `dist/core/actions.d.ts:2922-2938` | 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. |
|
|
@@ -102,7 +102,7 @@ could hand you spans for a version you do not have.
|
|
|
102
102
|
| `DataFabricSort` | interface | `dist/core/actions.d.ts:2125-2131` | Supporting types | How a multi-record query orders its rows before the limit is applied. |
|
|
103
103
|
| `dataFabricUpdate` | function | `dist/core/actions.d.ts:3226-3241` | Actions | Update an entity record in Data Fabric (`core.datafabric.update`). |
|
|
104
104
|
| `DataFabricUpdateInputs` | interface | `dist/core/actions.d.ts:2233-2264` | Option shapes | 5 field(s) |
|
|
105
|
-
| `DEFAULT_TRIGGER_ID` | const | `dist/core/expr.d.ts:
|
|
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
107
|
| `delay` | function | `dist/core/actions.d.ts:2704-2725` | 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. |
|
|
@@ -111,15 +111,15 @@ could hand you spans for a version you do not have.
|
|
|
111
111
|
| `documentClassify` | function | `dist/core/actions.d.ts:3149-3157` | Actions | Classify a document into a document type (`uipath.document.classify`). |
|
|
112
112
|
| `DocumentClassifyInputs` | interface | `dist/core/actions.d.ts:2292-2301` | 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
|
-
| `DoWhileOptions` | interface | `dist/flow-sdk.d.ts:
|
|
114
|
+
| `DoWhileOptions` | interface | `dist/flow-sdk.d.ts:412-421` | Option shapes | Do-while options. |
|
|
115
115
|
| `dynamicExtract` | function | `dist/core/actions.d.ts:3158-3168` | Actions | Extract fields from a document with an INLINE schema — Dynamic Extract (`uipath.ixp.extract-document-builder`), the… |
|
|
116
116
|
| `DynamicExtractInputs` | interface | `dist/core/actions.d.ts:2302-2336` | Option shapes | 5 field(s) |
|
|
117
|
-
| `EdgeRoute` | interface | `dist/flow-sdk.d.ts:
|
|
117
|
+
| `EdgeRoute` | interface | `dist/flow-sdk.d.ts:549-563` | Supporting types | One edge's route: user-dragged bends and/or the auto-router's waypoints. |
|
|
118
118
|
| `endCall` | function | `dist/core/actions.d.ts:2939-2946` | 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
|
-
| `entryInput` | function | `dist/core/expr.d.ts:
|
|
121
|
-
| `err` | function | `dist/core/expr.d.ts:
|
|
122
|
-
| `ErrorEnvelopeField` | type | `dist/core/expr.d.ts:
|
|
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
|
+
| `err` | function | `dist/core/expr.d.ts:153-240` | Expressions and types | Reference a FAILED step's error → `$vars.<step>.error[.<field>]`. |
|
|
122
|
+
| `ErrorEnvelopeField` | type | `dist/core/expr.d.ts:142-152` | Supporting types | The fields a failure envelope carries. |
|
|
123
123
|
| `EscalationRef` | interface | `dist/core/actions.d.ts:1916-1970` | Supporting types | One escalation an inline agent may raise — an Action Center app task a human completes (the `coded-action-app` variant,… |
|
|
124
124
|
| `EventFilter` | type | `dist/core/actions.d.ts:3347-3388` | Supporting types | One filter condition on the event payload. |
|
|
125
125
|
| `EventSubscription` | interface | `dist/core/actions.d.ts:3437-3478` | Option shapes | What a connector event subscribes to. |
|
|
@@ -128,17 +128,17 @@ could hand you spans for a version you do not have.
|
|
|
128
128
|
| `FilterCondition` | type | `dist/core/actions.d.ts:233-234` | Supporting types | Comparison a filter rule applies to a field. |
|
|
129
129
|
| `FilterMatch` | type | `dist/core/actions.d.ts:231-232` | Supporting types | How a filter combines its rules: every rule must match, or any one. |
|
|
130
130
|
| `FilterRule` | interface | `dist/core/actions.d.ts:235-247` | Supporting types | 3 field(s) |
|
|
131
|
-
| `flow` | function | `dist/flow-sdk.d.ts:
|
|
131
|
+
| `flow` | function | `dist/flow-sdk.d.ts:1371-1386` | Flow construction | Start building a flow with the given id. |
|
|
132
132
|
| `FlowAction` | class | `dist/core/node-classes.d.ts:158-164` | Supporting types | A node placed as a step — pass an instance to `.step(name, …)`. |
|
|
133
133
|
| `FlowActionSpec` | type | `dist/flow-sdk.d.ts:41-42` | Supporting types | What `.step()` accepts here: the shared actions plus this SDK's subflow. |
|
|
134
|
-
| `FlowBuilder` | class | `dist/flow-sdk.d.ts:
|
|
135
|
-
| `FlowLayout` | interface | `dist/flow-sdk.d.ts:
|
|
134
|
+
| `FlowBuilder` | class | `dist/flow-sdk.d.ts:1121-1370` | Builders | 13 member(s) |
|
|
135
|
+
| `FlowLayout` | interface | `dist/flow-sdk.d.ts:611-624` | Supporting types | Designer layout for a flow, keyed by AUTHOR-level ids: node entries by step name (plus the trigger id and `end`), edge… |
|
|
136
136
|
| `FlowNode` | class | `dist/core/node-classes.d.ts:122-157` | Supporting types | The abstract root of every definition-backed node the builder can place. |
|
|
137
137
|
| `FlowResource` | class | `dist/core/node-classes.d.ts:172-179` | Supporting types | A node attached to another semantic node — an inline agent's tool, context, memory, or escalation. |
|
|
138
138
|
| `FlowTrigger` | class | `dist/core/node-classes.d.ts:165-171` | Supporting types | A node that starts the flow — pass an instance to `.trigger(…)`. |
|
|
139
139
|
| `FormField` | type | `dist/core/actions.d.ts:383` | Supporting types | |
|
|
140
140
|
| `FormFieldType` | type | `dist/core/actions.d.ts:332-337` | Supporting types | A form field's type. |
|
|
141
|
-
| `formTrigger` | function | `dist/flow-sdk.d.ts:
|
|
141
|
+
| `formTrigger` | function | `dist/flow-sdk.d.ts:211-239` | Flow construction | Start the flow from a FORM a person fills in (`core.trigger.form`) — the platform renders one field per flow input and… |
|
|
142
142
|
| `GuardrailAction` | type | `dist/core/actions.d.ts:1318-1328` | Supporting types | What happens when a guardrail trips. |
|
|
143
143
|
| `GuardrailFieldReference` | interface | `dist/core/actions.d.ts:1285-1290` | Supporting types | A field the rule or filter action points at. |
|
|
144
144
|
| `GuardrailFieldSelector` | type | `dist/core/actions.d.ts:1291-1297` | Supporting types | All fields, or a named few. |
|
|
@@ -161,12 +161,12 @@ could hand you spans for a version you do not have.
|
|
|
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
162
|
| `InlineAgentInputs` | interface | `dist/core/actions.d.ts:1385-1640` | 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
|
-
| `input` | function | `dist/core/expr.d.ts:
|
|
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
166
|
| `ixpExtract` | function | `dist/core/actions.d.ts:2649-2703` | 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
168
|
| `IxpToolRef` | interface | `dist/core/actions.d.ts:1877-1915` | Supporting types | A published IxP (Intelligent eXtraction Platform) project as a tool — the agent decides when to extract a document and… |
|
|
169
|
-
| `js` | function | `dist/core/expr.d.ts:
|
|
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. |
|
|
172
172
|
| `lookup` | function | `dist/core/lookups.d.ts:103-122` | Generated descriptors | Begin resolving a lookup field addressed by connector key and action. |
|
|
@@ -180,19 +180,19 @@ could hand you spans for a version you do not have.
|
|
|
180
180
|
| `lookupSpecOf` | function | `dist/core/lookups.d.ts:199-206` | Generated descriptors | The LookupSpec for one field, or `undefined` when it earns no helper. |
|
|
181
181
|
| `LookupStrategy` | type | `dist/core/lookups.d.ts:1-10` | Generated descriptors | How `prepare` should retrieve the collection, chosen from the metadata. |
|
|
182
182
|
| `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:
|
|
183
|
+
| `LoopOptions` | interface | `dist/flow-sdk.d.ts:391-411` | Option shapes | Loop-specific options. |
|
|
184
|
+
| `manual` | function | `dist/flow-sdk.d.ts:134-143` | Flow construction | The manual trigger, explicitly. |
|
|
185
185
|
| `McpToolRef` | interface | `dist/core/actions.d.ts:1653-1681` | Supporting types | An MCP server the agent may call tools on. |
|
|
186
186
|
| `mock` | function | `dist/core/actions.d.ts:2726-2765` | 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
|
-
| `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:
|
|
192
|
-
| `out` | function | `dist/core/expr.d.ts:
|
|
188
|
+
| `NodeLayout` | interface | `dist/flow-sdk.d.ts:534-548` | Supporting types | One node's designer layout: canvas position, and optionally size and collapsed state. |
|
|
189
|
+
| `NodeOptions` | interface | `dist/flow-sdk.d.ts:313-358` | Option shapes | Options shared by every builder method that creates a definition-backed node: `version` selects the exact node… |
|
|
190
|
+
| `onEvent` | function | `dist/flow-sdk.d.ts:144-182` | Flow construction | Start the flow when a connector event fires — e.g. an email arriving in a mailbox folder. |
|
|
191
|
+
| `onEvent` | function | `dist/flow-sdk.d.ts:183-190` | Flow construction | Stringly form, for an event with no prepared module. |
|
|
192
|
+
| `out` | function | `dist/core/expr.d.ts:73-94` | Expressions and types | Reference an upstream step's output → `$vars.<step>.output[.<path>]`. |
|
|
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
|
-
| `PortArm` | interface | `dist/flow-sdk.d.ts:
|
|
195
|
+
| `PortArm` | interface | `dist/flow-sdk.d.ts:300-312` | Supporting types | One arm of a built `.stepSwitch` — the same shape as SwitchArm, but `value` names an exit the ACTION declares (a… |
|
|
196
196
|
| `ProcessToolKind` | type | `dist/core/actions.d.ts:1833-1846` | Supporting types | The tool kinds that wrap a DEPLOYED tenant resource. |
|
|
197
197
|
| `ProcessToolRef` | interface | `dist/core/actions.d.ts:1847-1876` | Supporting types | A deployed tenant resource the agent may invoke. |
|
|
198
198
|
| `publishedFunction` | function | `dist/core/actions.d.ts:2846-2870` | Actions | Invoke a published Orchestrator **Function** — a deployed unit of code run as one step (`uipath.core.function.<key>`,… |
|
|
@@ -200,21 +200,21 @@ could hand you spans for a version you do not have.
|
|
|
200
200
|
| `queueItem` | function | `dist/core/actions.d.ts:3260-3305` | Actions | Declare an Orchestrator QUEUE ITEM step. |
|
|
201
201
|
| `QueueItemInputs` | interface | `dist/core/actions.d.ts:2008-2081` | Option shapes | 10 field(s) |
|
|
202
202
|
| `QueuePriority` | type | `dist/core/actions.d.ts:2006-2007` | Supporting types | The three priorities an Orchestrator queue item can carry. |
|
|
203
|
-
| `ran` | function | `dist/core/expr.d.ts:
|
|
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
207
|
| `RemoteA2aToolRef` | interface | `dist/core/actions.d.ts:1682-1702` | 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
|
-
| `ReturnOptions` | interface | `dist/flow-sdk.d.ts:
|
|
210
|
+
| `ReturnOptions` | interface | `dist/flow-sdk.d.ts:359-390` | Option shapes | `.return(...)`-specific options. |
|
|
211
211
|
| `rpaWorkflow` | function | `dist/core/actions.d.ts:2766-2810` | 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
|
-
| `SCHEDULE_PRESETS` | const | `dist/flow-sdk.d.ts:
|
|
214
|
-
| `scheduled` | function | `dist/flow-sdk.d.ts:
|
|
215
|
-
| `ScheduledInputs` | interface | `dist/flow-sdk.d.ts:
|
|
216
|
-
| `ScheduleEvery` | type | `dist/flow-sdk.d.ts:
|
|
217
|
-
| `SchedulePreset` | type | `dist/flow-sdk.d.ts:
|
|
213
|
+
| `SCHEDULE_PRESETS` | const | `dist/flow-sdk.d.ts:81-88` | Flow construction | The eight intervals the designer offers in its Frequency dropdown. |
|
|
214
|
+
| `scheduled` | function | `dist/flow-sdk.d.ts:191-210` | Flow construction | Start the flow on a recurring schedule instead of on demand. |
|
|
215
|
+
| `ScheduledInputs` | interface | `dist/flow-sdk.d.ts:102-114` | Option shapes | 1 field(s) |
|
|
216
|
+
| `ScheduleEvery` | type | `dist/flow-sdk.d.ts:90-101` | Supporting types | How often a scheduled flow runs, as an ISO-8601 repeating interval: `R/` followed by a duration. |
|
|
217
|
+
| `SchedulePreset` | type | `dist/flow-sdk.d.ts:89` | Supporting types | |
|
|
218
218
|
| `script` | function | `dist/core/actions.d.ts:2467-2474` | 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… |
|
|
@@ -222,17 +222,17 @@ could hand you spans for a version you do not have.
|
|
|
222
222
|
| `sendMessage` | function | `dist/core/actions.d.ts:2871-2889` | 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
|
-
| `Step` | type | `dist/flow-sdk.d.ts:
|
|
226
|
-
| `StepList` | class | `dist/flow-sdk.d.ts:
|
|
227
|
-
| `STICKY_NOTE_COLORS` | const | `dist/flow-sdk.d.ts:
|
|
228
|
-
| `StickyNote` | interface | `dist/flow-sdk.d.ts:
|
|
229
|
-
| `StickyNoteColor` | type | `dist/flow-sdk.d.ts:
|
|
230
|
-
| `subflow` | function | `dist/flow-sdk.d.ts:
|
|
225
|
+
| `Step` | type | `dist/flow-sdk.d.ts:422-533` | Supporting types | |
|
|
226
|
+
| `StepList` | class | `dist/flow-sdk.d.ts:674-1096` | Builders | Collects a sequence of steps. |
|
|
227
|
+
| `STICKY_NOTE_COLORS` | const | `dist/flow-sdk.d.ts:564-569` | Flow construction | The designer's sticky-note palette. |
|
|
228
|
+
| `StickyNote` | interface | `dist/flow-sdk.d.ts:576-610` | Supporting types | A canvas sticky note — free text pinned to the diagram, for the humans reading it. |
|
|
229
|
+
| `StickyNoteColor` | type | `dist/flow-sdk.d.ts:570-575` | Supporting types | A sticky note's swatch. |
|
|
230
|
+
| `subflow` | function | `dist/flow-sdk.d.ts:1387-1426` | 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
232
|
| `summarize` | function | `dist/core/actions.d.ts:2573-2613` | 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
|
-
| `SwitchArm` | interface | `dist/flow-sdk.d.ts:
|
|
235
|
-
| `tmpl` | function | `dist/core/expr.d.ts:
|
|
234
|
+
| `SwitchArm` | interface | `dist/flow-sdk.d.ts:294-299` | Supporting types | One arm of a built `.switch` (the serializer's view: body already collected). |
|
|
235
|
+
| `tmpl` | function | `dist/core/expr.d.ts:253-263` | Expressions and types | Build a JS *string template* (for URLs, messages, etc.). |
|
|
236
236
|
| `ToolRef` | type | `dist/core/actions.d.ts:1643-1652` | Supporting types | One tool on an inline agent — a discriminated union over the kinds the tenant's registry actually serves… |
|
|
237
237
|
| `transform` | function | `dist/core/actions.d.ts:2475-2520` | 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. |
|
|
@@ -243,17 +243,17 @@ could hand you spans for a version you do not have.
|
|
|
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
245
|
| `TriggerOptions` | interface | `dist/core/actions.d.ts:3389-3436` | Option shapes | The typed `onEvent`/`waitForEvent` options — everything an EventSubscription carries except `connector`/`event`, which… |
|
|
246
|
-
| `TriggerSpec` | type | `dist/flow-sdk.d.ts:
|
|
247
|
-
| `TypeDesc` | type | `dist/core/expr.d.ts:
|
|
248
|
-
| `types` | const | `dist/core/expr.d.ts:
|
|
246
|
+
| `TriggerSpec` | type | `dist/flow-sdk.d.ts:115-133` | Supporting types | What starts the flow. |
|
|
247
|
+
| `TypeDesc` | type | `dist/core/expr.d.ts:328` | Supporting types | |
|
|
248
|
+
| `types` | const | `dist/core/expr.d.ts:312-327` | Expressions and types | Variable type descriptors (map to Flow variable `type` values). |
|
|
249
249
|
| `unresolvedLookupMessage` | function | `dist/core/lookups.d.ts:180-189` | Generated descriptors | The message for a lookup nothing has resolved — the command that fixes it. |
|
|
250
|
-
| `v` | function | `dist/core/expr.d.ts:29-
|
|
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-57` | Supporting types | 6 field(s) |
|
|
252
|
-
| `VarSpec` | interface | `dist/flow-sdk.d.ts:58-
|
|
252
|
+
| `VarSpec` | interface | `dist/flow-sdk.d.ts:58-80` | Supporting types | The rich spelling of a variable declaration: pass it instead of a bare `types.*` descriptor wherever `.input()` /… |
|
|
253
253
|
| `voiceAgent` | function | `dist/core/actions.d.ts:2947-2971` | 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
|
-
| `voiceTrigger` | function | `dist/flow-sdk.d.ts:
|
|
256
|
+
| `voiceTrigger` | function | `dist/flow-sdk.d.ts:267-291` | Flow construction | Start the flow when a phone call comes IN (`core.trigger.voice`). |
|
|
257
257
|
| `waitForEvent` | function | `dist/core/actions.d.ts:3488-3523` | Actions | Wait mid-flow until a connector event fires, then continue with its payload — the typed form, where a generated trigger… |
|
|
258
258
|
| `waitForEvent` | function | `dist/core/actions.d.ts:3524-3531` | Actions | Stringly form, for an event with no prepared module. |
|
|
259
259
|
| `waitForMessage` | function | `dist/core/actions.d.ts:2890-2906` | Actions | PAUSE until the person sends their next message (`uipath.conversational.wait-for-message`) — a catch event, like… |
|
|
@@ -337,7 +337,7 @@ could hand you spans for a version you do not have.
|
|
|
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
339
|
| `TriggerOptions` | interface | `dist/core/actions.d.ts:3389-3436` | Option shapes | The typed `onEvent`/`waitForEvent` options — everything an EventSubscription carries except `connector`/`event`, which… |
|
|
340
|
-
| `TypeDesc` | type | `dist/core/expr.d.ts:
|
|
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. |
|
|
343
343
|
| `WaitConnectorSpec` | type | `dist/case/case-sdk.d.ts:371-375` | Supporting types | A placeholder connector/operation pair, or a library-resolved event subscription using the same symbolic shape as Flow… |
|
|
@@ -346,99 +346,100 @@ could hand you spans for a version you do not have.
|
|
|
346
346
|
|
|
347
347
|
## `@uipath/maestro-builder-sdk/bpmn`
|
|
348
348
|
|
|
349
|
-
|
|
349
|
+
93 symbol(s). Import from `@uipath/maestro-builder-sdk/bpmn`.
|
|
350
350
|
|
|
351
351
|
| Symbol | Kind | Declaration | Area | Summary |
|
|
352
352
|
| --- | --- | --- | --- | --- |
|
|
353
|
-
| `ActivityBodyFn` | type | `dist/bpmn/bpmn-sdk.d.ts:
|
|
354
|
-
| `ActivityBuilder` | class | `dist/bpmn/bpmn-sdk.d.ts:
|
|
355
|
-
| `ActivityNodeFields` | interface | `dist/bpmn/bpmn-sdk.d.ts:
|
|
356
|
-
| `ActivityNodeOpts` | interface | `dist/bpmn/bpmn-sdk.d.ts:
|
|
357
|
-
| `ActivityOpts` | interface | `dist/bpmn/bpmn-sdk.d.ts:
|
|
358
|
-
| `ArmBodyFn` | type | `dist/bpmn/bpmn-sdk.d.ts:
|
|
359
|
-
| `BindingDecl` | interface | `dist/bpmn/bpmn-sdk.d.ts:
|
|
360
|
-
| `BindingEntry` | interface | `dist/bpmn/bpmn-sdk.d.ts:
|
|
361
|
-
| `BindingOpts` | interface | `dist/bpmn/bpmn-sdk.d.ts:
|
|
362
|
-
| `BindingsRegistry` | class | `dist/bpmn/bpmn-sdk.d.ts:
|
|
363
|
-
| `BoundaryOpts` | interface | `dist/bpmn/bpmn-sdk.d.ts:
|
|
364
|
-
| `bpmn` | function | `dist/bpmn/bpmn-sdk.d.ts:
|
|
365
|
-
| `BpmnBuilder` | class | `dist/bpmn/bpmn-sdk.d.ts:
|
|
366
|
-
| `BpmnConnectorOpts` | type | `dist/bpmn/bpmn-sdk.d.ts:
|
|
367
|
-
| `BpmnFlow` | interface | `dist/bpmn/bpmn-sdk.d.ts:
|
|
368
|
-
| `BpmnNode` | type | `dist/bpmn/bpmn-sdk.d.ts:87-
|
|
369
|
-
| `BpmnPreservation` | interface | `dist/bpmn/bpmn-sdk.d.ts:
|
|
370
|
-
| `BpmnVarDecl` | interface | `dist/bpmn/bpmn-sdk.d.ts:
|
|
371
|
-
| `BuiltBpmn` | interface | `dist/bpmn/bpmn-sdk.d.ts:
|
|
372
|
-
| `CatchOpts` | interface | `dist/bpmn/bpmn-sdk.d.ts:
|
|
373
|
-
| `ChooseArm` | type | `dist/bpmn/bpmn-sdk.d.ts:
|
|
374
|
-
| `ChooseOpts` | interface | `dist/bpmn/bpmn-sdk.d.ts:
|
|
353
|
+
| `ActivityBodyFn` | type | `dist/bpmn/bpmn-sdk.d.ts:1715-1719` | Supporting types | Boundary events declared on the activity they attach to — the callback every activity method accepts as its last… |
|
|
354
|
+
| `ActivityBuilder` | class | `dist/bpmn/bpmn-sdk.d.ts:3272-3371` | Builders | The boundary events of one activity, declared on the activity itself — what the body callback every activity method… |
|
|
355
|
+
| `ActivityNodeFields` | interface | `dist/bpmn/bpmn-sdk.d.ts:323-338` | Supporting types | The fields every activity arm of BpmnNode carries — the built form of ActivityOpts. |
|
|
356
|
+
| `ActivityNodeOpts` | interface | `dist/bpmn/bpmn-sdk.d.ts:1515-1605` | Option shapes | Options for `.activity()` — the generic registry-backed node. |
|
|
357
|
+
| `ActivityOpts` | interface | `dist/bpmn/bpmn-sdk.d.ts:807-840` | Option shapes | What every ACTIVITY accepts, on top of its own options — a script task, a variable task, a connector task, a… |
|
|
358
|
+
| `ArmBodyFn` | type | `dist/bpmn/bpmn-sdk.d.ts:1720-1721` | Supporting types | The elements of one branch arm or boundary-handler path — see PathBuilder. |
|
|
359
|
+
| `BindingDecl` | interface | `dist/bpmn/bpmn-sdk.d.ts:396-419` | Supporting types | A declared external identifier the process needs supplied at deploy time — a connection id, a folder key, a process… |
|
|
360
|
+
| `BindingEntry` | interface | `dist/bpmn/bpmn-sdk.d.ts:420-424` | Supporting types | One entry of BpmnBuilder.bindings — a `.binding()` call written as data. |
|
|
361
|
+
| `BindingOpts` | interface | `dist/bpmn/bpmn-sdk.d.ts:1005-1072` | Option shapes | Options for `.binding()`. |
|
|
362
|
+
| `BindingsRegistry` | class | `dist/bpmn/bpmn-sdk.d.ts:1978-2002` | Supporting types | Collects `uipath:binding` declarations, de-duped by id. |
|
|
363
|
+
| `BoundaryOpts` | interface | `dist/bpmn/bpmn-sdk.d.ts:732-756` | Option shapes | Options for `.boundaryEvent()`: the activity it attaches to, whether it interrupts that activity, and the event… |
|
|
364
|
+
| `bpmn` | function | `dist/bpmn/bpmn-sdk.d.ts:3616-3635` | BPMN authoring | Start building a BPMN process with the given id. |
|
|
365
|
+
| `BpmnBuilder` | class | `dist/bpmn/bpmn-sdk.d.ts:3372-3540` | Builders | The top-level process builder `bpmn()` returns — every graph method of the shared scope (events, gateways, tasks,… |
|
|
366
|
+
| `BpmnConnectorOpts` | type | `dist/bpmn/bpmn-sdk.d.ts:3113-3137` | Option shapes | `.connector()` options: the shared connector options, plus the BPMN-only display `name` and output-variable override. |
|
|
367
|
+
| `BpmnFlow` | interface | `dist/bpmn/bpmn-sdk.d.ts:339-359` | Supporting types | One sequence flow in the built graph — the edge from `source` to `target` (`bpmn:sequenceFlow`). |
|
|
368
|
+
| `BpmnNode` | type | `dist/bpmn/bpmn-sdk.d.ts:87-273` | Supporting types | One node in the built graph — a discriminated union with one arm per BPMN element kind, which the serializer walks into… |
|
|
369
|
+
| `BpmnPreservation` | interface | `dist/bpmn/bpmn-sdk.d.ts:441-484` | Supporting types | Non-authoring state retained by decompile/recompile. |
|
|
370
|
+
| `BpmnVarDecl` | interface | `dist/bpmn/bpmn-sdk.d.ts:365-395` | Supporting types | A declared variable in the built graph (`uipath:input` / `uipath:inputOutput` / `uipath:output`, by `direction`). |
|
|
371
|
+
| `BuiltBpmn` | interface | `dist/bpmn/bpmn-sdk.d.ts:485-512` | Supporting types | The built in-memory process graph `.build()` returns — the IR `serialize()` walks into `.bpmn` XML. |
|
|
372
|
+
| `CatchOpts` | interface | `dist/bpmn/bpmn-sdk.d.ts:709-722` | Option shapes | Options for `.intermediateCatchEvent()`. |
|
|
373
|
+
| `ChooseArm` | type | `dist/bpmn/bpmn-sdk.d.ts:1773-1799` | Supporting types | One arm of ScopeBuilder.choose: a `when` condition, or the single `otherwise` fallback. |
|
|
374
|
+
| `ChooseOpts` | interface | `dist/bpmn/bpmn-sdk.d.ts:1815-1826` | Option shapes | Options for ScopeBuilder.choose. |
|
|
375
375
|
| `ConnectorDescriptor` | type | `dist/core/connectors.d.ts:89-97` | Supporting types | A generated, typed connector descriptor: ConnectorMeta branded with phantom input/output types. |
|
|
376
|
-
| `ConnectorEventOpts` | interface | `dist/bpmn/bpmn-sdk.d.ts:
|
|
376
|
+
| `ConnectorEventOpts` | interface | `dist/bpmn/bpmn-sdk.d.ts:1416-1495` | Option shapes | Shared options for the two connector-event methods. |
|
|
377
377
|
| `ConnectorMeta` | interface | `dist/core/connectors.d.ts:60-88` | Supporting types | Runtime metadata a generated descriptor carries. |
|
|
378
378
|
| `ConnectorOpts` | interface | `dist/core/actions.d.ts:187-230` | Option shapes | 4 field(s) |
|
|
379
|
-
| `DataServiceOperation` | type | `dist/bpmn/data-service.d.ts:39-
|
|
380
|
-
| `DataServiceOpts` | interface | `dist/bpmn/bpmn-sdk.d.ts:
|
|
381
|
-
| `DefinitionsRegistry` | class | `dist/bpmn/bpmn-sdk.d.ts:
|
|
382
|
-
| `EndOpts` | interface | `dist/bpmn/bpmn-sdk.d.ts:
|
|
383
|
-
| `ErrorDecl` | interface | `dist/bpmn/bpmn-sdk.d.ts:
|
|
384
|
-
| `ErrorHandlerOpts` | interface | `dist/bpmn/bpmn-sdk.d.ts:
|
|
379
|
+
| `DataServiceOperation` | type | `dist/bpmn/data-service.d.ts:39-115` | Supporting types | The operation half of DataServiceOpts — one of eight, discriminated on `op`. |
|
|
380
|
+
| `DataServiceOpts` | interface | `dist/bpmn/bpmn-sdk.d.ts:1073-1121` | Option shapes | Options for `.dataService()` — one UiPath Data Fabric (Data Service) record or file operation. |
|
|
381
|
+
| `DefinitionsRegistry` | class | `dist/bpmn/bpmn-sdk.d.ts:2003-2026` | Supporting types | Collects definitions-level message/error declarations, de-duped by name. |
|
|
382
|
+
| `EndOpts` | interface | `dist/bpmn/bpmn-sdk.d.ts:684-708` | Option shapes | Options for `.endEvent()`. |
|
|
383
|
+
| `ErrorDecl` | interface | `dist/bpmn/bpmn-sdk.d.ts:432-440` | Supporting types | A definitions-level `bpmn:error` declaration, referenced by error events. |
|
|
384
|
+
| `ErrorHandlerOpts` | interface | `dist/bpmn/bpmn-sdk.d.ts:1739-1751` | Option shapes | Options for ActivityBuilder.onError. |
|
|
385
385
|
| `ErrorLike` | type | `dist/bpmn/bpmn-sdk.d.ts:41-52` | Supporting types | What an author passes for an error definition. |
|
|
386
|
-
| `ErrorMappingRow` | interface | `dist/bpmn/bpmn-sdk.d.ts:
|
|
387
|
-
| `errorSchema` | const | `dist/bpmn/bpmn-sdk.d.ts:
|
|
388
|
-
| `errorSchemaWithResponse` | const | `dist/bpmn/bpmn-sdk.d.ts:
|
|
386
|
+
| `ErrorMappingRow` | interface | `dist/bpmn/bpmn-sdk.d.ts:274-322` | Supporting types | One row of `uipath:errorMapping` — how an activity classifies one kind of failure. |
|
|
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
|
+
| `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:3347-3388` | Supporting types | One filter condition on the event payload. |
|
|
390
391
|
| `EventKind` | type | `dist/bpmn/bpmn-sdk.d.ts:74-75` | Supporting types | The four non-boundary event element kinds a BpmnNode can be. |
|
|
391
|
-
| `EventSubProcessOpts` | interface | `dist/bpmn/bpmn-sdk.d.ts:
|
|
392
|
-
| `ExtensionPayload` | interface | `dist/bpmn/bpmn-sdk.d.ts:
|
|
393
|
-
| `ExternalTaskOpts` | interface | `dist/bpmn/bpmn-sdk.d.ts:
|
|
394
|
-
| `FlowMode` | type | `dist/bpmn/bpmn-sdk.d.ts:
|
|
395
|
-
| `FlowOpts` | interface | `dist/bpmn/bpmn-sdk.d.ts:
|
|
392
|
+
| `EventSubProcessOpts` | interface | `dist/bpmn/bpmn-sdk.d.ts:1834-1894` | Option shapes | Options for ScopeBuilder.eventSubProcess. |
|
|
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. |
|
|
394
|
+
| `ExternalTaskOpts` | interface | `dist/bpmn/bpmn-sdk.d.ts:1496-1514` | Option shapes | Options for `.externalAgent()` / `.externalWorkflow()`. |
|
|
395
|
+
| `FlowMode` | type | `dist/bpmn/bpmn-sdk.d.ts:1895-1905` | Supporting types | How a scope wires elements no explicit `.sequenceFlow()` covers — see ScopeBuilder.flowMode. |
|
|
396
|
+
| `FlowOpts` | interface | `dist/bpmn/bpmn-sdk.d.ts:1632-1640` | Option shapes | Options for `.sequenceFlow()`. |
|
|
396
397
|
| `GatewayKind` | type | `dist/bpmn/bpmn-sdk.d.ts:72-73` | Supporting types | The four gateway element kinds a BpmnNode can be. |
|
|
397
|
-
| `GatewayNode` | type | `dist/bpmn/bpmn-sdk.d.ts:
|
|
398
|
-
| `GatewayOpts` | interface | `dist/bpmn/bpmn-sdk.d.ts:
|
|
399
|
-
| `HandlerOpts` | interface | `dist/bpmn/bpmn-sdk.d.ts:
|
|
400
|
-
| `HttpOpts` | interface | `dist/bpmn/bpmn-sdk.d.ts:
|
|
401
|
-
| `HumanTaskOpts` | interface | `dist/bpmn/bpmn-sdk.d.ts:
|
|
402
|
-
| `JoinOpts` | interface | `dist/bpmn/bpmn-sdk.d.ts:
|
|
398
|
+
| `GatewayNode` | type | `dist/bpmn/bpmn-sdk.d.ts:1908-1911` | Supporting types | A gateway node of the built graph. |
|
|
399
|
+
| `GatewayOpts` | interface | `dist/bpmn/bpmn-sdk.d.ts:757-763` | Option shapes | Options for `.exclusiveGateway()` / `.inclusiveGateway()`. |
|
|
400
|
+
| `HandlerOpts` | interface | `dist/bpmn/bpmn-sdk.d.ts:1722-1738` | Option shapes | What every boundary handler on an ActivityBuilder accepts — `.onError()`, `.onTimer()`, `.onMessage()`. |
|
|
401
|
+
| `HttpOpts` | interface | `dist/bpmn/bpmn-sdk.d.ts:1122-1206` | Option shapes | Options for `.http()` — an `Intsvc.UnifiedHttpRequest` node. |
|
|
402
|
+
| `HumanTaskOpts` | interface | `dist/bpmn/bpmn-sdk.d.ts:1325-1371` | Option shapes | Options for `.humanTask()` — an `Actions.HITL` action-app task. |
|
|
403
|
+
| `JoinOpts` | interface | `dist/bpmn/bpmn-sdk.d.ts:1800-1814` | Option shapes | The join gateway a construct emits when more than one arm falls through. |
|
|
403
404
|
| `LookupSpec` | interface | `dist/core/lookups.d.ts:11-36` | Supporting types | One lookup field's retrieval contract, generated from `reference`. |
|
|
404
405
|
| `LookupStrategy` | type | `dist/core/lookups.d.ts:1-10` | Supporting types | How `prepare` should retrieve the collection, chosen from the metadata. |
|
|
405
406
|
| `LoopSpec` | interface | `dist/bpmn/bpmn-sdk.d.ts:76-86` | Supporting types | Multi-instance loop over a collection (`uipath:loopCharacteristics`). |
|
|
406
|
-
| `MessageDecl` | interface | `dist/bpmn/bpmn-sdk.d.ts:
|
|
407
|
-
| `MessageHandlerOpts` | interface | `dist/bpmn/bpmn-sdk.d.ts:
|
|
408
|
-
| `OrchestratorAsyncOpts` | interface | `dist/bpmn/bpmn-sdk.d.ts:
|
|
409
|
-
| `OrchestratorOpts` | interface | `dist/bpmn/bpmn-sdk.d.ts:
|
|
410
|
-
| `PathBuilder` | class | `dist/bpmn/bpmn-sdk.d.ts:
|
|
411
|
-
| `PendingExit` | interface | `dist/bpmn/bpmn-sdk.d.ts:
|
|
412
|
-
| `PinnedFlowId` | interface | `dist/bpmn/bpmn-sdk.d.ts:
|
|
413
|
-
| `PlainTaskElement` | type | `dist/bpmn/bpmn-sdk.d.ts:
|
|
414
|
-
| `PlainTaskOpts` | interface | `dist/bpmn/bpmn-sdk.d.ts:
|
|
415
|
-
| `ProcessMetadata` | interface | `dist/bpmn/bpmn-sdk.d.ts:
|
|
416
|
-
| `QueueItemOpts` | interface | `dist/bpmn/bpmn-sdk.d.ts:
|
|
417
|
-
| `ReceiveMessageOpts` | interface | `dist/bpmn/bpmn-sdk.d.ts:
|
|
407
|
+
| `MessageDecl` | interface | `dist/bpmn/bpmn-sdk.d.ts:425-431` | Supporting types | A definitions-level `bpmn:message` declaration, referenced by message events. |
|
|
408
|
+
| `MessageHandlerOpts` | interface | `dist/bpmn/bpmn-sdk.d.ts:1768-1772` | Option shapes | Options for ActivityBuilder.onMessage. |
|
|
409
|
+
| `OrchestratorAsyncOpts` | interface | `dist/bpmn/bpmn-sdk.d.ts:1278-1285` | Option shapes | Options for the two agentic/case call activities, which come in sync and async forms. |
|
|
410
|
+
| `OrchestratorOpts` | interface | `dist/bpmn/bpmn-sdk.d.ts:1207-1277` | Option shapes | What every Orchestrator invocation needs: which process, in which folder, with what input. |
|
|
411
|
+
| `PathBuilder` | class | `dist/bpmn/bpmn-sdk.d.ts:3209-3271` | Builders | One arm of a `choose` / `fork` / `race`, or one boundary handler's path: the same graph methods as any scope, written… |
|
|
412
|
+
| `PendingExit` | interface | `dist/bpmn/bpmn-sdk.d.ts:1912-1931` | Supporting types | An edge waiting for the element that continues it: the open end of an arm, a handler, or a join, plus what the flow… |
|
|
413
|
+
| `PinnedFlowId` | interface | `dist/bpmn/bpmn-sdk.d.ts:1621-1631` | Supporting types | One implied edge whose id is pinned — see ScopeBuilder.flowIds. |
|
|
414
|
+
| `PlainTaskElement` | type | `dist/bpmn/bpmn-sdk.d.ts:1606-1613` | Supporting types | The BPMN task elements that are legal with NO `uipath:*` payload. |
|
|
415
|
+
| `PlainTaskOpts` | interface | `dist/bpmn/bpmn-sdk.d.ts:1614-1620` | Option shapes | Options for `.plainTask()`. |
|
|
416
|
+
| `ProcessMetadata` | interface | `dist/bpmn/bpmn-sdk.d.ts:513-555` | Supporting types | Process-level metadata — the `uipath:*` children of the process's own `extensionElements` that describe the DOCUMENT… |
|
|
417
|
+
| `QueueItemOpts` | interface | `dist/bpmn/bpmn-sdk.d.ts:1286-1324` | Option shapes | Options for `.queueItem()`. |
|
|
418
|
+
| `ReceiveMessageOpts` | interface | `dist/bpmn/bpmn-sdk.d.ts:1372-1415` | Option shapes | Options for `.receiveMessage()` — `Maestro.ReceiveMessageEvent`. |
|
|
418
419
|
| `RegistryContextField` | interface | `dist/bpmn/typed-node.d.ts:20-40` | Supporting types | One context field of a typed node, as the registry describes it. |
|
|
419
420
|
| `RegistryInputField` | interface | `dist/bpmn/typed-node.d.ts:41-69` | Supporting types | One PAYLOAD field of a typed node — the registry's `InputFields`, as distinct from the `ContextFields` above. |
|
|
420
421
|
| `RegistryOutput` | interface | `dist/bpmn/typed-node.d.ts:70-77` | Supporting types | The output row a typed node writes, or `null` when it has none. |
|
|
421
422
|
| `RegistryTypeSpec` | interface | `dist/bpmn/typed-node.d.ts:78-96` | Supporting types | One extension type's emission spec. |
|
|
422
|
-
| `RetrySpec` | interface | `dist/bpmn/bpmn-sdk.d.ts:
|
|
423
|
-
| `SchemaEntry` | interface | `dist/bpmn/bpmn-sdk.d.ts:
|
|
424
|
-
| `ScopeBuilder` | class | `dist/bpmn/bpmn-sdk.d.ts:
|
|
425
|
-
| `ScopeStorage` | interface | `dist/bpmn/bpmn-sdk.d.ts:
|
|
426
|
-
| `ScriptTaskOpts` | interface | `dist/bpmn/bpmn-sdk.d.ts:
|
|
427
|
-
| `SplitOpts` | interface | `dist/bpmn/bpmn-sdk.d.ts:
|
|
428
|
-
| `StartOpts` | interface | `dist/bpmn/bpmn-sdk.d.ts:
|
|
429
|
-
| `SubProcessBuilder` | class | `dist/bpmn/bpmn-sdk.d.ts:
|
|
430
|
-
| `SubProcessOpts` | interface | `dist/bpmn/bpmn-sdk.d.ts:
|
|
431
|
-
| `SugarRegistry` | class | `dist/bpmn/bpmn-sdk.d.ts:
|
|
432
|
-
| `TaskOpts` | interface | `dist/bpmn/bpmn-sdk.d.ts:
|
|
433
|
-
| `ThrowOpts` | interface | `dist/bpmn/bpmn-sdk.d.ts:
|
|
434
|
-
| `TimerHandlerOpts` | interface | `dist/bpmn/bpmn-sdk.d.ts:
|
|
423
|
+
| `RetrySpec` | interface | `dist/bpmn/bpmn-sdk.d.ts:764-806` | Supporting types | Retry an activity that fails (`uipath:retry`). |
|
|
424
|
+
| `SchemaEntry` | interface | `dist/bpmn/bpmn-sdk.d.ts:998-1004` | Supporting types | One entry of BpmnBuilder.schemas — a `.schema()` call written as data. |
|
|
425
|
+
| `ScopeBuilder` | class | `dist/bpmn/bpmn-sdk.d.ts:2027-3112` | Builders | The set of node/flow/variable methods common to the process root and every sub-process. |
|
|
426
|
+
| `ScopeStorage` | interface | `dist/bpmn/bpmn-sdk.d.ts:1932-1945` | Supporting types | The arrays an arm shares with the scope it is written into. |
|
|
427
|
+
| `ScriptTaskOpts` | interface | `dist/bpmn/bpmn-sdk.d.ts:841-955` | Option shapes | Options for `.scriptTask()` — the Jint JavaScript body and its input/output mappings. |
|
|
428
|
+
| `SplitOpts` | interface | `dist/bpmn/bpmn-sdk.d.ts:1827-1833` | Option shapes | Options for ScopeBuilder.fork and ScopeBuilder.race. |
|
|
429
|
+
| `StartOpts` | interface | `dist/bpmn/bpmn-sdk.d.ts:593-683` | Option shapes | Options for `.startEvent()`. |
|
|
430
|
+
| `SubProcessBuilder` | class | `dist/bpmn/bpmn-sdk.d.ts:3190-3208` | Builders | A sub-process body: the same graph methods, plus an internal node builder. |
|
|
431
|
+
| `SubProcessOpts` | interface | `dist/bpmn/bpmn-sdk.d.ts:971-985` | Option shapes | Options for `.subProcess()`. |
|
|
432
|
+
| `SugarRegistry` | class | `dist/bpmn/bpmn-sdk.d.ts:1946-1964` | Supporting types | Bookkeeping the nesting sugar shares across every scope of one process. |
|
|
433
|
+
| `TaskOpts` | interface | `dist/bpmn/bpmn-sdk.d.ts:956-970` | Option shapes | Options for `.task()` — a display name and the variable assignments the task makes. |
|
|
434
|
+
| `ThrowOpts` | interface | `dist/bpmn/bpmn-sdk.d.ts:723-731` | Option shapes | Options for `.intermediateThrowEvent()` — a `message` to throw, or none. |
|
|
435
|
+
| `TimerHandlerOpts` | interface | `dist/bpmn/bpmn-sdk.d.ts:1752-1767` | Option shapes | Options for ActivityBuilder.onTimer. |
|
|
435
436
|
| `TimerLike` | type | `dist/bpmn/bpmn-sdk.d.ts:39-40` | Supporting types | A timer as an ISO-8601 duration string (shorthand for `{ duration }`) or a full spec. |
|
|
436
437
|
| `TimerSpec` | interface | `dist/bpmn/bpmn-sdk.d.ts:30-38` | Supporting types | ISO-8601 timer specification (one of duration / date / cycle). |
|
|
437
438
|
| `TypedContextRow` | interface | `dist/bpmn/typed-node.d.ts:155-186` | Supporting types | One `uipath:context` input row, spelled out. |
|
|
438
|
-
| `TypeDesc` | type | `dist/core/expr.d.ts:
|
|
439
|
+
| `TypeDesc` | type | `dist/core/expr.d.ts:328` | Supporting types | |
|
|
439
440
|
| `TypedInputRow` | interface | `dist/bpmn/typed-node.d.ts:187-209` | Supporting types | One `uipath:input` payload row spelled out — the `separateInputs` counterpart of TypedContextRow. |
|
|
440
441
|
| `TypedOutputRow` | interface | `dist/bpmn/typed-node.d.ts:246-285` | Supporting types | 9 field(s) |
|
|
441
|
-
| `VarDirection` | type | `dist/bpmn/bpmn-sdk.d.ts:
|
|
442
|
-
| `VarEntry` | interface | `dist/bpmn/bpmn-sdk.d.ts:
|
|
443
|
-
| `VarOpts` | interface | `dist/bpmn/bpmn-sdk.d.ts:
|
|
444
|
-
| `WiringMode` | type | `dist/bpmn/bpmn-sdk.d.ts:
|
|
442
|
+
| `VarDirection` | type | `dist/bpmn/bpmn-sdk.d.ts:360-364` | Supporting types | How a variable is exposed: `'input'` (read-only entry input), `'output'` (a return value), or `'inputOutput'` (a mutable… |
|
|
443
|
+
| `VarEntry` | interface | `dist/bpmn/bpmn-sdk.d.ts:986-997` | Supporting types | One entry of ScopeBuilder.vars — a `.var()` / `.input()` / `.output()` call written as data. |
|
|
444
|
+
| `VarOpts` | interface | `dist/bpmn/bpmn-sdk.d.ts:1641-1714` | Option shapes | Options for `.var()` / `.input()` / `.output()`. |
|
|
445
|
+
| `WiringMode` | type | `dist/bpmn/bpmn-sdk.d.ts:1906-1907` | Supporting types | The builder-internal spelling of FlowMode, kept so the field types read as what they are. |
|