@uipath/maestro-builder-sdk 6.55.0 → 6.57.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 +103 -82
- package/dist/api-members.md +373 -346
- package/dist/bpmn/bpmn-sdk.d.ts +110 -27
- package/dist/bpmn/bpmn-sdk.js +84 -6
- package/dist/bpmn/declared-vars.js +3 -2
- package/dist/bpmn/decompile.js +66 -0
- package/dist/bpmn/human-task-form.d.ts +170 -0
- package/dist/bpmn/human-task-form.js +321 -0
- package/dist/bpmn/serialize.js +8 -0
- package/dist/bpmn/typed-node.d.ts +6 -0
- package/dist/bpmn/typed-node.js +6 -0
- package/dist/cli/commands/flow.js +2 -0
- package/dist/core/script-function.d.ts +126 -0
- package/dist/core/script-function.js +510 -0
- package/dist/decompile-cli.js +11 -3
- package/dist/decompile.d.ts +9 -0
- package/dist/decompile.js +76 -3
- package/dist/flow-node-type.d.ts +21 -0
- package/dist/load.js +13 -0
- package/dist/nodes/script/flow/factories.d.ts +42 -1
- package/dist/nodes/script/flow/factories.js +8 -9
- package/dist/nodes/script/flow/node-type.js +71 -0
- package/dist/nodes/script/flow/runtime.d.ts +20 -0
- package/dist/nodes/script/flow/runtime.js +29 -0
- package/dist/nodes/script/flow/spec.d.ts +32 -1
- package/dist/script-function-scope.d.ts +57 -0
- package/dist/script-function-scope.js +203 -0
- package/package.json +2 -2
package/dist/api-index.md
CHANGED
|
@@ -37,7 +37,7 @@ could hand you spans for a version you do not have.
|
|
|
37
37
|
|
|
38
38
|
## `@uipath/maestro-builder-sdk`
|
|
39
39
|
|
|
40
|
-
|
|
40
|
+
236 symbol(s). Import from `@uipath/maestro-builder-sdk`.
|
|
41
41
|
|
|
42
42
|
| Symbol | Kind | Declaration | Area | Summary |
|
|
43
43
|
| --- | --- | --- | --- | --- |
|
|
@@ -229,10 +229,14 @@ could hand you spans for a version you do not have.
|
|
|
229
229
|
| `ScheduledInputs` | interface | `dist/flow-sdk.d.ts:151-163` | Option shapes | 1 field(s) |
|
|
230
230
|
| `ScheduleEvery` | type | `dist/flow-sdk.d.ts:139-150` | Supporting types | How often a scheduled flow runs, as an ISO-8601 repeating interval: `R/` followed by a duration. |
|
|
231
231
|
| `SchedulePreset` | type | `dist/flow-sdk.d.ts:138` | Supporting types | |
|
|
232
|
-
| `script` | function | `dist/nodes/script/flow/factories.d.ts:
|
|
232
|
+
| `script` | function | `dist/nodes/script/flow/factories.d.ts:8-36` | Actions | Declare an inline script action, as a TypeScript function the compiler checks. |
|
|
233
|
+
| `script` | function | `dist/nodes/script/flow/factories.d.ts:37-47` | Actions | Declare an inline script action, as a TypeScript function, with no declared return: the body's type is inferred as it is… |
|
|
234
|
+
| `script` | function | `dist/nodes/script/flow/factories.d.ts:48-55` | Actions | Declare an inline script action. |
|
|
233
235
|
| `ScriptInputs` | interface | `dist/nodes/script/flow/spec.d.ts:7-44` | Option shapes | 2 field(s) |
|
|
234
236
|
| `ScriptReturns` | type | `dist/core/script-return.d.ts:42-48` | Supporting types | What an author may write for `script({ returns })`: the type outright, or — for an object return — the FIELDS, which is… |
|
|
235
237
|
| `ScriptReturnType` | type | `dist/core/script-return.d.ts:31-41` | Supporting types | The vocabulary a script's output can be declared as. |
|
|
238
|
+
| `ScriptValue` | type | `dist/nodes/script/flow/spec.d.ts:65-75` | Supporting types | What a script function must return for a given `returns`: the type a name stands for, or, for a field map, an object… |
|
|
239
|
+
| `ScriptValueOf` | type | `dist/nodes/script/flow/spec.d.ts:63-64` | Supporting types | The TypeScript type one of ScriptReturnType's names stands for. |
|
|
236
240
|
| `sendMessage` | function | `dist/nodes/conversation/flow/factories.d.ts:8-26` | Actions | Post an assistant message into a live conversation (`uipath.conversational.send-message`). |
|
|
237
241
|
| `SendMessageInputs` | interface | `dist/nodes/conversation/flow/spec.d.ts:8-27` | Option shapes | 4 field(s) |
|
|
238
242
|
| `ShownField` | interface | `dist/core/actions.d.ts:205-220` | Supporting types | A value the reviewer READS: shown on the form, filled in from the flow. |
|
|
@@ -366,101 +370,118 @@ could hand you spans for a version you do not have.
|
|
|
366
370
|
|
|
367
371
|
## `@uipath/maestro-builder-sdk/bpmn`
|
|
368
372
|
|
|
369
|
-
|
|
373
|
+
111 symbol(s). Import from `@uipath/maestro-builder-sdk/bpmn`.
|
|
370
374
|
|
|
371
375
|
| Symbol | Kind | Declaration | Area | Summary |
|
|
372
376
|
| --- | --- | --- | --- | --- |
|
|
373
|
-
| `ActivityBodyFn` | type | `dist/bpmn/bpmn-sdk.d.ts:
|
|
374
|
-
| `ActivityBuilder` | class | `dist/bpmn/bpmn-sdk.d.ts:
|
|
375
|
-
| `ActivityNodeFields` | interface | `dist/bpmn/bpmn-sdk.d.ts:
|
|
376
|
-
| `ActivityNodeOpts` | interface | `dist/bpmn/bpmn-sdk.d.ts:
|
|
377
|
-
| `ActivityOpts` | interface | `dist/bpmn/bpmn-sdk.d.ts:
|
|
378
|
-
| `ArmBodyFn` | type | `dist/bpmn/bpmn-sdk.d.ts:
|
|
379
|
-
| `BindingDecl` | interface | `dist/bpmn/bpmn-sdk.d.ts:
|
|
380
|
-
| `BindingEntry` | interface | `dist/bpmn/bpmn-sdk.d.ts:
|
|
381
|
-
| `BindingOpts` | interface | `dist/bpmn/bpmn-sdk.d.ts:
|
|
382
|
-
| `BindingsRegistry` | class | `dist/bpmn/bpmn-sdk.d.ts:
|
|
383
|
-
| `BoundaryOpts` | interface | `dist/bpmn/bpmn-sdk.d.ts:
|
|
384
|
-
| `bpmn` | function | `dist/bpmn/bpmn-sdk.d.ts:
|
|
385
|
-
| `BpmnBuilder` | class | `dist/bpmn/bpmn-sdk.d.ts:
|
|
386
|
-
| `BpmnConnectorOpts` | type | `dist/bpmn/bpmn-sdk.d.ts:
|
|
387
|
-
| `BpmnFlow` | interface | `dist/bpmn/bpmn-sdk.d.ts:
|
|
388
|
-
| `BpmnNode` | type | `dist/bpmn/bpmn-sdk.d.ts:
|
|
389
|
-
| `BpmnPreservation` | interface | `dist/bpmn/bpmn-sdk.d.ts:
|
|
390
|
-
| `BpmnVarDecl` | interface | `dist/bpmn/bpmn-sdk.d.ts:
|
|
391
|
-
| `BuiltBpmn` | interface | `dist/bpmn/bpmn-sdk.d.ts:
|
|
392
|
-
| `
|
|
393
|
-
| `
|
|
394
|
-
| `
|
|
377
|
+
| `ActivityBodyFn` | type | `dist/bpmn/bpmn-sdk.d.ts:1802-1806` | Supporting types | Boundary events declared on the activity they attach to — the callback every activity method accepts as its last… |
|
|
378
|
+
| `ActivityBuilder` | class | `dist/bpmn/bpmn-sdk.d.ts:3407-3506` | Builders | The boundary events of one activity, declared on the activity itself — what the body callback every activity method… |
|
|
379
|
+
| `ActivityNodeFields` | interface | `dist/bpmn/bpmn-sdk.d.ts:342-357` | Supporting types | The fields every activity arm of BpmnNode carries — the built form of ActivityOpts. |
|
|
380
|
+
| `ActivityNodeOpts` | interface | `dist/bpmn/bpmn-sdk.d.ts:1596-1692` | Option shapes | Options for `.activity()` — the generic registry-backed node. |
|
|
381
|
+
| `ActivityOpts` | interface | `dist/bpmn/bpmn-sdk.d.ts:842-875` | Option shapes | What every ACTIVITY accepts, on top of its own options — a script task, a variable task, a connector task, a… |
|
|
382
|
+
| `ArmBodyFn` | type | `dist/bpmn/bpmn-sdk.d.ts:1807-1808` | Supporting types | The elements of one branch arm or boundary-handler path — see PathBuilder. |
|
|
383
|
+
| `BindingDecl` | interface | `dist/bpmn/bpmn-sdk.d.ts:415-438` | Supporting types | A declared external identifier the process needs supplied at deploy time — a connection id, a folder key, a process… |
|
|
384
|
+
| `BindingEntry` | interface | `dist/bpmn/bpmn-sdk.d.ts:439-443` | Supporting types | One entry of BpmnBuilder.bindings — a `.binding()` call written as data. |
|
|
385
|
+
| `BindingOpts` | interface | `dist/bpmn/bpmn-sdk.d.ts:1040-1107` | Option shapes | Options for `.binding()`. |
|
|
386
|
+
| `BindingsRegistry` | class | `dist/bpmn/bpmn-sdk.d.ts:2075-2099` | Supporting types | Collects `uipath:binding` declarations, de-duped by id. |
|
|
387
|
+
| `BoundaryOpts` | interface | `dist/bpmn/bpmn-sdk.d.ts:767-791` | Option shapes | Options for `.boundaryEvent()`: the activity it attaches to, whether it interrupts that activity, and the event… |
|
|
388
|
+
| `bpmn` | function | `dist/bpmn/bpmn-sdk.d.ts:3751-3770` | BPMN authoring | Start building a BPMN process with the given id. |
|
|
389
|
+
| `BpmnBuilder` | class | `dist/bpmn/bpmn-sdk.d.ts:3507-3675` | Builders | The top-level process builder `bpmn()` returns — every graph method of the shared scope (events, gateways, tasks,… |
|
|
390
|
+
| `BpmnConnectorOpts` | type | `dist/bpmn/bpmn-sdk.d.ts:3285-3324` | Option shapes | `.connector()` options: the shared connector options, plus the BPMN-only display `name` and output-variable override. |
|
|
391
|
+
| `BpmnFlow` | interface | `dist/bpmn/bpmn-sdk.d.ts:358-378` | Supporting types | One sequence flow in the built graph — the edge from `source` to `target` (`bpmn:sequenceFlow`). |
|
|
392
|
+
| `BpmnNode` | type | `dist/bpmn/bpmn-sdk.d.ts:90-292` | Supporting types | One node in the built graph — a discriminated union with one arm per BPMN element kind, which the serializer walks into… |
|
|
393
|
+
| `BpmnPreservation` | interface | `dist/bpmn/bpmn-sdk.d.ts:460-503` | Supporting types | Non-authoring state retained by decompile/recompile. |
|
|
394
|
+
| `BpmnVarDecl` | interface | `dist/bpmn/bpmn-sdk.d.ts:384-414` | Supporting types | A declared variable in the built graph (`uipath:input` / `uipath:inputOutput` / `uipath:output`, by `direction`). |
|
|
395
|
+
| `BuiltBpmn` | interface | `dist/bpmn/bpmn-sdk.d.ts:504-531` | Supporting types | The built in-memory process graph `.build()` returns — the IR `serialize()` walks into `.bpmn` XML. |
|
|
396
|
+
| `CanonicalFormFieldType` | type | `dist/core/actions.d.ts:57-63` | Supporting types | The platform's 11 canonical quick-form field types (`@uipath/hitl-schema-types` `fieldType`), which the designer saves. |
|
|
397
|
+
| `CatchOpts` | interface | `dist/bpmn/bpmn-sdk.d.ts:744-757` | Option shapes | Options for `.intermediateCatchEvent()`. |
|
|
398
|
+
| `ChooseArm` | type | `dist/bpmn/bpmn-sdk.d.ts:1860-1886` | Supporting types | One arm of ScopeBuilder.choose: a `when` condition, or the single `otherwise` fallback. |
|
|
399
|
+
| `ChooseOpts` | interface | `dist/bpmn/bpmn-sdk.d.ts:1902-1913` | Option shapes | Options for ScopeBuilder.choose. |
|
|
395
400
|
| `ConnectorDescriptor` | type | `dist/core/connectors.d.ts:89-97` | Supporting types | A generated, typed connector descriptor: ConnectorMeta branded with phantom input/output types. |
|
|
396
|
-
| `ConnectorEventOpts` | interface | `dist/bpmn/bpmn-sdk.d.ts:
|
|
401
|
+
| `ConnectorEventOpts` | interface | `dist/bpmn/bpmn-sdk.d.ts:1492-1576` | Option shapes | Shared options for the two connector-event methods. |
|
|
397
402
|
| `ConnectorMeta` | interface | `dist/core/connectors.d.ts:60-88` | Supporting types | Runtime metadata a generated descriptor carries. |
|
|
398
403
|
| `ConnectorOpts` | interface | `dist/core/actions.d.ts:13-56` | Option shapes | 4 field(s) |
|
|
399
|
-
| `ConnectorOutputRow` | interface | `dist/bpmn/bpmn-sdk.d.ts:
|
|
404
|
+
| `ConnectorOutputRow` | interface | `dist/bpmn/bpmn-sdk.d.ts:3271-3284` | Supporting types | One extra output row on a connector task, spelled out — the object form of an entry in BpmnConnectorOpts' `outputs`. |
|
|
405
|
+
| `ControlFormFieldType` | type | `dist/core/actions.d.ts:64-72` | Supporting types | The platform's choice-control spellings of a field type. |
|
|
400
406
|
| `DataServiceOperation` | type | `dist/bpmn/data-service.d.ts:39-115` | Supporting types | The operation half of DataServiceOpts — one of eight, discriminated on `op`. |
|
|
401
|
-
| `DataServiceOpts` | interface | `dist/bpmn/bpmn-sdk.d.ts:
|
|
402
|
-
| `DefinitionsRegistry` | class | `dist/bpmn/bpmn-sdk.d.ts:
|
|
403
|
-
| `EndOpts` | interface | `dist/bpmn/bpmn-sdk.d.ts:
|
|
404
|
-
| `ErrorDecl` | interface | `dist/bpmn/bpmn-sdk.d.ts:
|
|
405
|
-
| `ErrorHandlerOpts` | interface | `dist/bpmn/bpmn-sdk.d.ts:
|
|
406
|
-
| `ErrorLike` | type | `dist/bpmn/bpmn-sdk.d.ts:
|
|
407
|
-
| `ErrorMappingRow` | interface | `dist/bpmn/bpmn-sdk.d.ts:
|
|
408
|
-
| `errorSchema` | const | `dist/bpmn/bpmn-sdk.d.ts:
|
|
409
|
-
| `errorSchemaWithResponse` | const | `dist/bpmn/bpmn-sdk.d.ts:
|
|
410
|
-
| `EventDef` | type | `dist/bpmn/bpmn-sdk.d.ts:
|
|
407
|
+
| `DataServiceOpts` | interface | `dist/bpmn/bpmn-sdk.d.ts:1108-1156` | Option shapes | Options for `.dataService()` — one UiPath Data Fabric (Data Service) record or file operation. |
|
|
408
|
+
| `DefinitionsRegistry` | class | `dist/bpmn/bpmn-sdk.d.ts:2100-2123` | Supporting types | Collects definitions-level message/error declarations, de-duped by name. |
|
|
409
|
+
| `EndOpts` | interface | `dist/bpmn/bpmn-sdk.d.ts:719-743` | Option shapes | Options for `.endEvent()`. |
|
|
410
|
+
| `ErrorDecl` | interface | `dist/bpmn/bpmn-sdk.d.ts:451-459` | Supporting types | A definitions-level `bpmn:error` declaration, referenced by error events. |
|
|
411
|
+
| `ErrorHandlerOpts` | interface | `dist/bpmn/bpmn-sdk.d.ts:1826-1838` | Option shapes | Options for ActivityBuilder.onError. |
|
|
412
|
+
| `ErrorLike` | type | `dist/bpmn/bpmn-sdk.d.ts:44-55` | Supporting types | What an author passes for an error definition. |
|
|
413
|
+
| `ErrorMappingRow` | interface | `dist/bpmn/bpmn-sdk.d.ts:293-341` | Supporting types | One row of `uipath:errorMapping` — how an activity classifies one kind of failure. |
|
|
414
|
+
| `errorSchema` | const | `dist/bpmn/bpmn-sdk.d.ts:3676-3717` | BPMN authoring | The `Error` variable's shape — the platform's own error envelope. |
|
|
415
|
+
| `errorSchemaWithResponse` | const | `dist/bpmn/bpmn-sdk.d.ts:3718-3750` | BPMN authoring | The same envelope plus `response` — what a node whose failure carries a payload writes, and what the same source calls… |
|
|
416
|
+
| `EventDef` | type | `dist/bpmn/bpmn-sdk.d.ts:56-74` | Supporting types | The resolved event definition attached to an event node. |
|
|
411
417
|
| `EventFilter` | type | `dist/core/actions.d.ts:925-966` | Supporting types | One filter condition on the event payload. |
|
|
412
|
-
| `EventKind` | type | `dist/bpmn/bpmn-sdk.d.ts:
|
|
413
|
-
| `EventSubProcessOpts` | interface | `dist/bpmn/bpmn-sdk.d.ts:
|
|
414
|
-
| `ExtensionPayload` | interface | `dist/bpmn/bpmn-sdk.d.ts:
|
|
415
|
-
| `ExternalTaskOpts` | interface | `dist/bpmn/bpmn-sdk.d.ts:
|
|
416
|
-
| `FlowMode` | type | `dist/bpmn/bpmn-sdk.d.ts:
|
|
417
|
-
| `FlowOpts` | interface | `dist/bpmn/bpmn-sdk.d.ts:
|
|
418
|
-
| `
|
|
419
|
-
| `
|
|
420
|
-
| `
|
|
421
|
-
| `
|
|
422
|
-
| `
|
|
423
|
-
| `
|
|
424
|
-
| `
|
|
418
|
+
| `EventKind` | type | `dist/bpmn/bpmn-sdk.d.ts:77-78` | Supporting types | The four non-boundary event element kinds a BpmnNode can be. |
|
|
419
|
+
| `EventSubProcessOpts` | interface | `dist/bpmn/bpmn-sdk.d.ts:1921-1983` | Option shapes | Options for ScopeBuilder.eventSubProcess. |
|
|
420
|
+
| `ExtensionPayload` | interface | `dist/bpmn/bpmn-sdk.d.ts:582-618` | Supporting types | An extension payload carried by an element the payload does not describe. |
|
|
421
|
+
| `ExternalTaskOpts` | interface | `dist/bpmn/bpmn-sdk.d.ts:1577-1595` | Option shapes | Options for `.externalAgent()` / `.externalWorkflow()`. |
|
|
422
|
+
| `FlowMode` | type | `dist/bpmn/bpmn-sdk.d.ts:1984-1994` | Supporting types | How a scope wires elements no explicit `.sequenceFlow()` covers — see ScopeBuilder.flowMode. |
|
|
423
|
+
| `FlowOpts` | interface | `dist/bpmn/bpmn-sdk.d.ts:1719-1727` | Option shapes | Options for `.sequenceFlow()`. |
|
|
424
|
+
| `FormFieldCondition` | interface | `dist/core/actions.d.ts:113-133` | Supporting types | One condition of a form-field rule (`@uipath/hitl-schema-types` `fieldConditionSchema`): `when` names the field it… |
|
|
425
|
+
| `FormFieldControlType` | type | `dist/core/actions.d.ts:105-112` | Supporting types | How a form field renders (`@uipath/hitl-schema-types` `controlType`). |
|
|
426
|
+
| `FormFieldOption` | interface | `dist/core/actions.d.ts:92-104` | Supporting types | One choice of a picker field (`@uipath/hitl-schema-types` `optionShape`): `value` is what the answer holds, `label` what… |
|
|
427
|
+
| `FormFieldRule` | interface | `dist/core/actions.d.ts:134-161` | Supporting types | A form-field rule (`@uipath/hitl-schema-types` `fieldRuleSchema`): when its conditions hold, its `effects` apply to the… |
|
|
428
|
+
| `FormFieldSettings` | interface | `dist/core/actions.d.ts:162-204` | Supporting types | The form-field keys that say how a field looks and behaves, with the platform's own names and shapes… |
|
|
429
|
+
| `FormFieldType` | type | `dist/core/actions.d.ts:73-91` | Supporting types | A form field's type: one of the platform's canonical types; `'text'` / `'date-time'`, the SDK's older spellings of… |
|
|
430
|
+
| `GatewayKind` | type | `dist/bpmn/bpmn-sdk.d.ts:75-76` | Supporting types | The four gateway element kinds a BpmnNode can be. |
|
|
431
|
+
| `GatewayNode` | type | `dist/bpmn/bpmn-sdk.d.ts:1997-2000` | Supporting types | A gateway node of the built graph. |
|
|
432
|
+
| `GatewayOpts` | interface | `dist/bpmn/bpmn-sdk.d.ts:792-798` | Option shapes | Options for `.exclusiveGateway()` / `.inclusiveGateway()`. |
|
|
433
|
+
| `HandlerOpts` | interface | `dist/bpmn/bpmn-sdk.d.ts:1809-1825` | Option shapes | What every boundary handler on an ActivityBuilder accepts — `.onError()`, `.onTimer()`, `.onMessage()`. |
|
|
434
|
+
| `HttpOpts` | interface | `dist/bpmn/bpmn-sdk.d.ts:1157-1247` | Option shapes | Options for `.http()` — an `Intsvc.UnifiedHttpRequest` node. |
|
|
435
|
+
| `HumanTaskAppOpts` | interface | `dist/bpmn/bpmn-sdk.d.ts:1388-1417` | Option shapes | Options for `.humanTask()` backed by an Action App — an `Actions.HITL` action-app task. |
|
|
436
|
+
| `HumanTaskAskedField` | interface | `dist/bpmn/human-task-form.d.ts:46-59` | Supporting types | A value the reviewer FILLS IN, landing in a process variable. |
|
|
437
|
+
| `HumanTaskCommonOpts` | interface | `dist/bpmn/bpmn-sdk.d.ts:1366-1387` | Option shapes | What both variants of `.humanTask()` take. |
|
|
438
|
+
| `HumanTaskForm` | interface | `dist/bpmn/human-task-form.d.ts:83-99` | Supporting types | An inline form — the quick-form variant of `.humanTask()`, which needs no Action App. |
|
|
439
|
+
| `HumanTaskFormField` | type | `dist/bpmn/human-task-form.d.ts:76-77` | Supporting types | One field of an inline human-task form. |
|
|
440
|
+
| `HumanTaskFormOpts` | interface | `dist/bpmn/bpmn-sdk.d.ts:1418-1441` | Option shapes | Options for `.humanTask()` with an INLINE form — the quick-form `Actions.HITL` task, which needs no Action App. |
|
|
441
|
+
| `HumanTaskInOutField` | interface | `dist/bpmn/human-task-form.d.ts:60-75` | Supporting types | A value the reviewer READS AND CAN CORRECT: pre-filled, editable, and written back. |
|
|
442
|
+
| `HumanTaskOpts` | type | `dist/bpmn/bpmn-sdk.d.ts:1442-1447` | Option shapes | Options for `.humanTask()` — an `Actions.HITL` task, backed by an Action App (HumanTaskAppOpts) or by an inline form… |
|
|
443
|
+
| `HumanTaskOutcome` | type | `dist/bpmn/human-task-form.d.ts:78-82` | Supporting types | One button the reviewer can finish the task with. |
|
|
444
|
+
| `HumanTaskShownField` | interface | `dist/bpmn/human-task-form.d.ts:31-45` | Supporting types | A value the reviewer READS: shown on the form, filled in from the process. |
|
|
445
|
+
| `JoinOpts` | interface | `dist/bpmn/bpmn-sdk.d.ts:1887-1901` | Option shapes | The join gateway a construct emits when more than one arm falls through. |
|
|
425
446
|
| `LookupSpec` | interface | `dist/core/lookups.d.ts:11-36` | Supporting types | One lookup field's retrieval contract, generated from `reference`. |
|
|
426
447
|
| `LookupStrategy` | type | `dist/core/lookups.d.ts:1-10` | Supporting types | How `prepare` should retrieve the collection, chosen from the metadata. |
|
|
427
|
-
| `LoopSpec` | interface | `dist/bpmn/bpmn-sdk.d.ts:
|
|
428
|
-
| `MessageDecl` | interface | `dist/bpmn/bpmn-sdk.d.ts:
|
|
429
|
-
| `MessageHandlerOpts` | interface | `dist/bpmn/bpmn-sdk.d.ts:
|
|
430
|
-
| `OrchestratorAsyncOpts` | interface | `dist/bpmn/bpmn-sdk.d.ts:
|
|
431
|
-
| `OrchestratorOpts` | interface | `dist/bpmn/bpmn-sdk.d.ts:
|
|
432
|
-
| `PathBuilder` | class | `dist/bpmn/bpmn-sdk.d.ts:
|
|
433
|
-
| `PendingExit` | interface | `dist/bpmn/bpmn-sdk.d.ts:
|
|
434
|
-
| `PinnedFlowId` | interface | `dist/bpmn/bpmn-sdk.d.ts:
|
|
435
|
-
| `PlainTaskElement` | type | `dist/bpmn/bpmn-sdk.d.ts:
|
|
436
|
-
| `PlainTaskOpts` | interface | `dist/bpmn/bpmn-sdk.d.ts:
|
|
437
|
-
| `ProcessMetadata` | interface | `dist/bpmn/bpmn-sdk.d.ts:
|
|
438
|
-
| `QueueItemOpts` | interface | `dist/bpmn/bpmn-sdk.d.ts:
|
|
439
|
-
| `ReceiveMessageOpts` | interface | `dist/bpmn/bpmn-sdk.d.ts:
|
|
448
|
+
| `LoopSpec` | interface | `dist/bpmn/bpmn-sdk.d.ts:79-89` | Supporting types | Multi-instance loop over a collection (`uipath:loopCharacteristics`). |
|
|
449
|
+
| `MessageDecl` | interface | `dist/bpmn/bpmn-sdk.d.ts:444-450` | Supporting types | A definitions-level `bpmn:message` declaration, referenced by message events. |
|
|
450
|
+
| `MessageHandlerOpts` | interface | `dist/bpmn/bpmn-sdk.d.ts:1855-1859` | Option shapes | Options for ActivityBuilder.onMessage. |
|
|
451
|
+
| `OrchestratorAsyncOpts` | interface | `dist/bpmn/bpmn-sdk.d.ts:1319-1326` | Option shapes | Options for the two agentic/case call activities, which come in sync and async forms. |
|
|
452
|
+
| `OrchestratorOpts` | interface | `dist/bpmn/bpmn-sdk.d.ts:1248-1318` | Option shapes | What every Orchestrator invocation needs: which process, in which folder, with what input. |
|
|
453
|
+
| `PathBuilder` | class | `dist/bpmn/bpmn-sdk.d.ts:3344-3406` | Builders | One arm of a `choose` / `fork` / `race`, or one boundary handler's path: the same graph methods as any scope, written… |
|
|
454
|
+
| `PendingExit` | interface | `dist/bpmn/bpmn-sdk.d.ts:2001-2020` | 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… |
|
|
455
|
+
| `PinnedFlowId` | interface | `dist/bpmn/bpmn-sdk.d.ts:1708-1718` | Supporting types | One implied edge whose id is pinned — see ScopeBuilder.flowIds. |
|
|
456
|
+
| `PlainTaskElement` | type | `dist/bpmn/bpmn-sdk.d.ts:1693-1700` | Supporting types | The BPMN task elements that are legal with NO `uipath:*` payload. |
|
|
457
|
+
| `PlainTaskOpts` | interface | `dist/bpmn/bpmn-sdk.d.ts:1701-1707` | Option shapes | Options for `.plainTask()`. |
|
|
458
|
+
| `ProcessMetadata` | interface | `dist/bpmn/bpmn-sdk.d.ts:532-581` | Supporting types | Process-level metadata — the `uipath:*` children of the process's own `extensionElements` that describe the DOCUMENT… |
|
|
459
|
+
| `QueueItemOpts` | interface | `dist/bpmn/bpmn-sdk.d.ts:1327-1365` | Option shapes | Options for `.queueItem()`. |
|
|
460
|
+
| `ReceiveMessageOpts` | interface | `dist/bpmn/bpmn-sdk.d.ts:1448-1491` | Option shapes | Options for `.receiveMessage()` — `Maestro.ReceiveMessageEvent`. |
|
|
440
461
|
| `RegistryContextField` | interface | `dist/bpmn/typed-node.d.ts:20-47` | Supporting types | One context field of a typed node, as the registry describes it. |
|
|
441
462
|
| `RegistryInputField` | interface | `dist/bpmn/typed-node.d.ts:48-76` | Supporting types | One PAYLOAD field of a typed node — the registry's `InputFields`, as distinct from the `ContextFields` above. |
|
|
442
463
|
| `RegistryOutput` | interface | `dist/bpmn/typed-node.d.ts:77-84` | Supporting types | The output row a typed node writes, or `null` when it has none. |
|
|
443
464
|
| `RegistryTypeSpec` | interface | `dist/bpmn/typed-node.d.ts:85-130` | Supporting types | One extension type's emission spec. |
|
|
444
|
-
| `RetrySpec` | interface | `dist/bpmn/bpmn-sdk.d.ts:
|
|
445
|
-
| `SchemaEntry` | interface | `dist/bpmn/bpmn-sdk.d.ts:
|
|
446
|
-
| `ScopeBuilder` | class | `dist/bpmn/bpmn-sdk.d.ts:
|
|
447
|
-
| `ScopeStorage` | interface | `dist/bpmn/bpmn-sdk.d.ts:
|
|
448
|
-
| `ScriptTaskOpts` | interface | `dist/bpmn/bpmn-sdk.d.ts:
|
|
449
|
-
| `SplitOpts` | interface | `dist/bpmn/bpmn-sdk.d.ts:
|
|
450
|
-
| `StartOpts` | interface | `dist/bpmn/bpmn-sdk.d.ts:
|
|
451
|
-
| `SubProcessBuilder` | class | `dist/bpmn/bpmn-sdk.d.ts:
|
|
452
|
-
| `SubProcessOpts` | interface | `dist/bpmn/bpmn-sdk.d.ts:
|
|
453
|
-
| `SugarRegistry` | class | `dist/bpmn/bpmn-sdk.d.ts:
|
|
454
|
-
| `TaskOpts` | interface | `dist/bpmn/bpmn-sdk.d.ts:
|
|
455
|
-
| `ThrowOpts` | interface | `dist/bpmn/bpmn-sdk.d.ts:
|
|
456
|
-
| `TimerHandlerOpts` | interface | `dist/bpmn/bpmn-sdk.d.ts:
|
|
457
|
-
| `TimerLike` | type | `dist/bpmn/bpmn-sdk.d.ts:
|
|
458
|
-
| `TimerSpec` | interface | `dist/bpmn/bpmn-sdk.d.ts:
|
|
465
|
+
| `RetrySpec` | interface | `dist/bpmn/bpmn-sdk.d.ts:799-841` | Supporting types | Retry an activity that fails (`uipath:retry`). |
|
|
466
|
+
| `SchemaEntry` | interface | `dist/bpmn/bpmn-sdk.d.ts:1033-1039` | Supporting types | One entry of BpmnBuilder.schemas — a `.schema()` call written as data. |
|
|
467
|
+
| `ScopeBuilder` | class | `dist/bpmn/bpmn-sdk.d.ts:2124-3270` | Builders | The set of node/flow/variable methods common to the process root and every sub-process. |
|
|
468
|
+
| `ScopeStorage` | interface | `dist/bpmn/bpmn-sdk.d.ts:2021-2034` | Supporting types | The arrays an arm shares with the scope it is written into. |
|
|
469
|
+
| `ScriptTaskOpts` | interface | `dist/bpmn/bpmn-sdk.d.ts:876-990` | Option shapes | Options for `.scriptTask()` — the Jint JavaScript body and its input/output mappings. |
|
|
470
|
+
| `SplitOpts` | interface | `dist/bpmn/bpmn-sdk.d.ts:1914-1920` | Option shapes | Options for ScopeBuilder.fork and ScopeBuilder.race. |
|
|
471
|
+
| `StartOpts` | interface | `dist/bpmn/bpmn-sdk.d.ts:619-718` | Option shapes | Options for `.startEvent()`. |
|
|
472
|
+
| `SubProcessBuilder` | class | `dist/bpmn/bpmn-sdk.d.ts:3325-3343` | Builders | A sub-process body: the same graph methods, plus an internal node builder. |
|
|
473
|
+
| `SubProcessOpts` | interface | `dist/bpmn/bpmn-sdk.d.ts:1006-1020` | Option shapes | Options for `.subProcess()`. |
|
|
474
|
+
| `SugarRegistry` | class | `dist/bpmn/bpmn-sdk.d.ts:2035-2061` | Supporting types | Bookkeeping the nesting sugar shares across every scope of one process. |
|
|
475
|
+
| `TaskOpts` | interface | `dist/bpmn/bpmn-sdk.d.ts:991-1005` | Option shapes | Options for `.task()` — a display name and the variable assignments the task makes. |
|
|
476
|
+
| `ThrowOpts` | interface | `dist/bpmn/bpmn-sdk.d.ts:758-766` | Option shapes | Options for `.intermediateThrowEvent()` — a `message` to throw, or none. |
|
|
477
|
+
| `TimerHandlerOpts` | interface | `dist/bpmn/bpmn-sdk.d.ts:1839-1854` | Option shapes | Options for ActivityBuilder.onTimer. |
|
|
478
|
+
| `TimerLike` | type | `dist/bpmn/bpmn-sdk.d.ts:42-43` | Supporting types | A timer as an ISO-8601 duration string (shorthand for `{ duration }`) or a full spec. |
|
|
479
|
+
| `TimerSpec` | interface | `dist/bpmn/bpmn-sdk.d.ts:33-41` | Supporting types | ISO-8601 timer specification (one of duration / date / cycle). |
|
|
459
480
|
| `TypedContextRow` | interface | `dist/bpmn/typed-node.d.ts:200-231` | Supporting types | One `uipath:context` input row, spelled out. |
|
|
460
481
|
| `TypeDesc` | type | `dist/core/expr.d.ts:385` | Supporting types | |
|
|
461
482
|
| `TypedInputRow` | interface | `dist/bpmn/typed-node.d.ts:232-254` | Supporting types | One `uipath:input` payload row spelled out — the `separateInputs` counterpart of TypedContextRow. |
|
|
462
483
|
| `TypedOutputRow` | interface | `dist/bpmn/typed-node.d.ts:291-330` | Supporting types | 9 field(s) |
|
|
463
|
-
| `VarDirection` | type | `dist/bpmn/bpmn-sdk.d.ts:
|
|
464
|
-
| `VarEntry` | interface | `dist/bpmn/bpmn-sdk.d.ts:
|
|
465
|
-
| `VarOpts` | interface | `dist/bpmn/bpmn-sdk.d.ts:
|
|
466
|
-
| `WiringMode` | type | `dist/bpmn/bpmn-sdk.d.ts:
|
|
484
|
+
| `VarDirection` | type | `dist/bpmn/bpmn-sdk.d.ts:379-383` | Supporting types | How a variable is exposed: `'input'` (read-only entry input), `'output'` (a return value), or `'inputOutput'` (a mutable… |
|
|
485
|
+
| `VarEntry` | interface | `dist/bpmn/bpmn-sdk.d.ts:1021-1032` | Supporting types | One entry of ScopeBuilder.vars — a `.var()` / `.input()` / `.output()` call written as data. |
|
|
486
|
+
| `VarOpts` | interface | `dist/bpmn/bpmn-sdk.d.ts:1728-1801` | Option shapes | Options for `.var()` / `.input()` / `.output()`. |
|
|
487
|
+
| `WiringMode` | type | `dist/bpmn/bpmn-sdk.d.ts:1995-1996` | Supporting types | The builder-internal spelling of FlowMode, kept so the field types read as what they are. |
|