@uipath/maestro-builder-sdk 6.35.1 → 6.36.1

package/dist/api-index.md

@@ -37,7 +37,7 @@ could hand you spans for a version you do not have.
 
 ## `@uipath/maestro-builder-sdk`
 
-228 symbol(s). Import from `@uipath/maestro-builder-sdk`.
+230 symbol(s). Import from `@uipath/maestro-builder-sdk`.
 
 | Symbol | Kind | Declaration | Area | Summary |
 | --- | --- | --- | --- | --- |
@@ -58,13 +58,14 @@ could hand you spans for a version you do not have.
 | `apiWorkflow` | function | `dist/core/actions.d.ts:1842-1876` | Actions | Invoke a deployed API workflow — a coded workflow published to Orchestrator, run as a serverless job rather than by a… |
 | `ApiWorkflowInputs` | interface | `dist/core/actions.d.ts:553-584` | Option shapes | 5 field(s) |
 | `AppRef` | interface | `dist/nodes/hitl/flow/spec.d.ts:140-185` | Supporting types | A deployed Action App that supplies a human task's form — the `'action-app'` variant's subject. |
-| `ArmBuilder` | class | `dist/flow-sdk.d.ts:1269-1292` | Builders | The sub-builder an ARM callback receives — a `StepList` that can also name itself with `.label(...)`. |
+| `ArmBuilder` | class | `dist/flow-sdk.d.ts:1321-1344` | Builders | The sub-builder an ARM callback receives — a `StepList` that can also name itself with `.label(...)`. |
 | `AskedField` | interface | `dist/core/actions.d.ts:221-231` | Supporting types | A value the reviewer FILLS IN: read downstream with `out('<step>', '<id>')`. |
+| `at` | function | `dist/flow-sdk.d.ts:657-685` | Flow construction | A node's layout at a canvas position — the short form of a NodeLayout for the `nodes` map of FlowBuilder.layout. |
 | `batchTransform` | function | `dist/nodes/ai-patterns/flow/factories.d.ts:49-83` | Actions | Add AI-generated columns to a CSV — the platform's **Batch transform** node, `uipath.pattern.batch-transform` (service… |
 | `BatchTransformInputs` | interface | `dist/nodes/ai-patterns/flow/spec.d.ts:48-63` | Option shapes | 4 field(s) |
 | `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… |
-| `BuiltEntryPoint` | interface | `dist/flow-sdk.d.ts:733-745` | Supporting types | One additional flow root, built by `.entryPoint()`. |
-| `BuiltFlow` | interface | `dist/flow-sdk.d.ts:746-793` | Supporting types | 17 field(s) |
+| `BuiltEntryPoint` | interface | `dist/flow-sdk.d.ts:785-797` | Supporting types | One additional flow root, built by `.entryPoint()`. |
+| `BuiltFlow` | interface | `dist/flow-sdk.d.ts:798-845` | Supporting types | 17 field(s) |
 | `BuiltinToolName` | type | `dist/core/actions.d.ts:1208-1209` | Supporting types | The three platform-shipped built-in tools (fixed registry types). |
 | `BuiltinToolRef` | interface | `dist/core/actions.d.ts:1377-1397` | Supporting types | A platform built-in tool. |
 | `BuiltInValidatorGuardrail` | interface | `dist/core/actions.d.ts:904-945` | Supporting types | A platform-shipped validator, configured by parameters. |
@@ -111,13 +112,14 @@ could hand you spans for a version you do not have.
 | `DELAY_PRESETS` | const | `dist/nodes/delay/flow/spec.d.ts:6-13` | Actions | The twelve durations the designer's dropdown offers. |
 | `DelayInputs` | type | `dist/nodes/delay/flow/spec.d.ts:14-35` | Option shapes |  |
 | `descriptor` | function | `dist/core/connectors.d.ts:98-110` | Generated descriptors | Brand a descriptor literal with its input/output types (zero runtime cost). |
+| `dim` | function | `dist/flow-sdk.d.ts:686-708` | Flow construction | A node's size on the canvas, in pixels — the third argument of at. |
 | `documentClassify` | function | `dist/nodes/document/flow/factories.d.ts:8-16` | Actions | Classify a document into a document type (`uipath.document.classify`). |
 | `DocumentClassifyInputs` | interface | `dist/nodes/document/flow/spec.d.ts:9-18` | Option shapes | 4 field(s) |
 | `DocValidationInputs` | interface | `dist/nodes/hitl/flow/spec.d.ts:70-93` | Option shapes | The Document Validation task's subject — `variant: 'document-validation'` only. |
 | `DoWhileOptions` | interface | `dist/flow-sdk.d.ts:512-521` | Option shapes | Do-while options. |
 | `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… |
 | `DynamicExtractInputs` | interface | `dist/nodes/document/flow/spec.d.ts:19-53` | Option shapes | 5 field(s) |
-| `EdgeRoute` | interface | `dist/flow-sdk.d.ts:657-671` | Supporting types | One edge's route: user-dragged bends and/or the auto-router's waypoints. |
+| `EdgeRoute` | interface | `dist/flow-sdk.d.ts:709-723` | Supporting types | One edge's route: user-dragged bends and/or the auto-router's waypoints. |
 | `endCall` | function | `dist/core/actions.d.ts:1919-1926` | Actions | Hang up (`uipath.conversational.voice.end-call`). |
 | `EndCallInputs` | interface | `dist/core/actions.d.ts:331-338` | Option shapes | 1 field(s) |
 | `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` —… |
@@ -131,12 +133,12 @@ could hand you spans for a version you do not have.
 | `FilterCondition` | type | `dist/nodes/transform/flow/spec.d.ts:10-11` | Supporting types | Comparison a filter rule applies to a field. |
 | `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. |
 | `FilterRule` | interface | `dist/nodes/transform/flow/spec.d.ts:12-24` | Supporting types | 3 field(s) |
-| `flow` | function | `dist/flow-sdk.d.ts:1657-1672` | Flow construction | Start building a flow with the given id. |
+| `flow` | function | `dist/flow-sdk.d.ts:1725-1740` | Flow construction | Start building a flow with the given id. |
 | `FlowAction` | class | `dist/core/node-classes.d.ts:162-168` | Supporting types | A node placed as a step — pass an instance to `.step(name, …)`. |
 | `FlowActionSpec` | type | `dist/flow-sdk.d.ts:53-54` | Supporting types | What `.step()` accepts here: the shared actions plus this SDK's subflow. |
 | `FlowActionSpecs` | interface | `dist/core/actions.d.ts:1627-1704` | Supporting types | Every action kind, keyed by kind, to the body of its spec — the arm's fields other than `kind`. |
-| `FlowBuilder` | class | `dist/flow-sdk.d.ts:1293-1656` | Builders | 15 member(s) |
-| `FlowLayout` | interface | `dist/flow-sdk.d.ts:719-732` | Supporting types | Designer layout for a flow, keyed by AUTHOR-level ids: node entries by step name (plus the trigger id and `end`), edge… |
+| `FlowBuilder` | class | `dist/flow-sdk.d.ts:1345-1724` | Builders | 15 member(s) |
+| `FlowLayout` | interface | `dist/flow-sdk.d.ts:771-784` | Supporting types | Designer layout for a flow, keyed by AUTHOR-level ids: node entries by step name (plus the trigger id and `end`), edge… |
 | `FlowNode` | class | `dist/core/node-classes.d.ts:126-161` | Supporting types | The abstract root of every definition-backed node the builder can place. |
 | `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. |
 | `FlowTrigger` | class | `dist/core/node-classes.d.ts:169-175` | Supporting types | A node that starts the flow — pass an instance to `.trigger(…)`. |
@@ -233,11 +235,11 @@ could hand you spans for a version you do not have.
 | `SendMessageInputs` | interface | `dist/nodes/conversation/flow/spec.d.ts:8-27` | Option shapes | 4 field(s) |
 | `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. |
 | `Step` | type | `dist/flow-sdk.d.ts:522-641` | Supporting types |  |
-| `StepList` | class | `dist/flow-sdk.d.ts:794-1268` | Builders | Collects a sequence of steps. |
-| `STICKY_NOTE_COLORS` | const | `dist/flow-sdk.d.ts:672-677` | Flow construction | The designer's sticky-note palette. |
-| `StickyNote` | interface | `dist/flow-sdk.d.ts:684-718` | Supporting types | A canvas sticky note — free text pinned to the diagram, for the humans reading it. |
-| `StickyNoteColor` | type | `dist/flow-sdk.d.ts:678-683` | Supporting types | A sticky note's swatch. |
-| `subflow` | function | `dist/flow-sdk.d.ts:1673-1712` | Flow construction | Run another flow as one step, and read back what it returns. |
+| `StepList` | class | `dist/flow-sdk.d.ts:846-1320` | Builders | Collects a sequence of steps. |
+| `STICKY_NOTE_COLORS` | const | `dist/flow-sdk.d.ts:724-729` | Flow construction | The designer's sticky-note palette. |
+| `StickyNote` | interface | `dist/flow-sdk.d.ts:736-770` | Supporting types | A canvas sticky note — free text pinned to the diagram, for the humans reading it. |
+| `StickyNoteColor` | type | `dist/flow-sdk.d.ts:730-735` | Supporting types | A sticky note's swatch. |
+| `subflow` | function | `dist/flow-sdk.d.ts:1741-1780` | Flow construction | Run another flow as one step, and read back what it returns. |
 | `SubflowSpec` | interface | `dist/flow-sdk.d.ts:45-52` | Supporting types | A step that runs a child flow. |
 | `summarize` | function | `dist/nodes/ai-patterns/flow/factories.d.ts:8-48` | Actions | Summarize a document with citations — the platform's **Summarize** node. |
 | `SummarizeInputs` | interface | `dist/nodes/ai-patterns/flow/spec.d.ts:8-40` | Option shapes | 3 field(s) |
@@ -364,7 +366,7 @@ could hand you spans for a version you do not have.
 | Symbol | Kind | Declaration | Area | Summary |
 | --- | --- | --- | --- | --- |
 | `ActivityBodyFn` | type | `dist/bpmn/bpmn-sdk.d.ts:1716-1720` | Supporting types | Boundary events declared on the activity they attach to — the callback every activity method accepts as its last… |
-| `ActivityBuilder` | class | `dist/bpmn/bpmn-sdk.d.ts:3221-3320` | Builders | The boundary events of one activity, declared on the activity itself — what the body callback every activity method… |
+| `ActivityBuilder` | class | `dist/bpmn/bpmn-sdk.d.ts:3250-3349` | Builders | The boundary events of one activity, declared on the activity itself — what the body callback every activity method… |
 | `ActivityNodeFields` | interface | `dist/bpmn/bpmn-sdk.d.ts:324-339` | Supporting types | The fields every activity arm of BpmnNode carries — the built form of ActivityOpts. |
 | `ActivityNodeOpts` | interface | `dist/bpmn/bpmn-sdk.d.ts:1516-1606` | Option shapes | Options for `.activity()` — the generic registry-backed node. |
 | `ActivityOpts` | interface | `dist/bpmn/bpmn-sdk.d.ts:808-841` | Option shapes | What every ACTIVITY accepts, on top of its own options — a script task, a variable task, a connector task, a… |
@@ -374,9 +376,9 @@ could hand you spans for a version you do not have.
 | `BindingOpts` | interface | `dist/bpmn/bpmn-sdk.d.ts:1006-1073` | Option shapes | Options for `.binding()`. |
 | `BindingsRegistry` | class | `dist/bpmn/bpmn-sdk.d.ts:1979-2003` | Supporting types | Collects `uipath:binding` declarations, de-duped by id. |
 | `BoundaryOpts` | interface | `dist/bpmn/bpmn-sdk.d.ts:733-757` | Option shapes | Options for `.boundaryEvent()`: the activity it attaches to, whether it interrupts that activity, and the event… |
-| `bpmn` | function | `dist/bpmn/bpmn-sdk.d.ts:3565-3584` | BPMN authoring | Start building a BPMN process with the given id. |
-| `BpmnBuilder` | class | `dist/bpmn/bpmn-sdk.d.ts:3321-3489` | Builders | The top-level process builder `bpmn()` returns — every graph method of the shared scope (events, gateways, tasks,… |
-| `BpmnConnectorOpts` | type | `dist/bpmn/bpmn-sdk.d.ts:3114-3138` | Option shapes | `.connector()` options: the shared connector options, plus the BPMN-only display `name` and output-variable override. |
+| `bpmn` | function | `dist/bpmn/bpmn-sdk.d.ts:3594-3613` | BPMN authoring | Start building a BPMN process with the given id. |
+| `BpmnBuilder` | class | `dist/bpmn/bpmn-sdk.d.ts:3350-3518` | Builders | The top-level process builder `bpmn()` returns — every graph method of the shared scope (events, gateways, tasks,… |
+| `BpmnConnectorOpts` | type | `dist/bpmn/bpmn-sdk.d.ts:3143-3167` | Option shapes | `.connector()` options: the shared connector options, plus the BPMN-only display `name` and output-variable override. |
 | `BpmnFlow` | interface | `dist/bpmn/bpmn-sdk.d.ts:340-360` | Supporting types | One sequence flow in the built graph — the edge from `source` to `target` (`bpmn:sequenceFlow`). |
 | `BpmnNode` | type | `dist/bpmn/bpmn-sdk.d.ts:88-274` | Supporting types | One node in the built graph — a discriminated union with one arm per BPMN element kind, which the serializer walks into… |
 | `BpmnPreservation` | interface | `dist/bpmn/bpmn-sdk.d.ts:442-485` | Supporting types | Non-authoring state retained by decompile/recompile. |
@@ -397,8 +399,8 @@ could hand you spans for a version you do not have.
 | `ErrorHandlerOpts` | interface | `dist/bpmn/bpmn-sdk.d.ts:1740-1752` | Option shapes | Options for ActivityBuilder.onError. |
 | `ErrorLike` | type | `dist/bpmn/bpmn-sdk.d.ts:42-53` | Supporting types | What an author passes for an error definition. |
 | `ErrorMappingRow` | interface | `dist/bpmn/bpmn-sdk.d.ts:275-323` | Supporting types | One row of `uipath:errorMapping` — how an activity classifies one kind of failure. |
-| `errorSchema` | const | `dist/bpmn/bpmn-sdk.d.ts:3490-3531` | BPMN authoring | The `Error` variable's shape — the platform's own error envelope. |
-| `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… |
+| `errorSchema` | const | `dist/bpmn/bpmn-sdk.d.ts:3519-3560` | BPMN authoring | The `Error` variable's shape — the platform's own error envelope. |
+| `errorSchemaWithResponse` | const | `dist/bpmn/bpmn-sdk.d.ts:3561-3593` | BPMN authoring | The same envelope plus `response` — what a node whose failure carries a payload writes, and what the same source calls… |
 | `EventDef` | type | `dist/bpmn/bpmn-sdk.d.ts:54-72` | Supporting types | The resolved event definition attached to an event node. |
 | `EventFilter` | type | `dist/core/actions.d.ts:2170-2211` | Supporting types | One filter condition on the event payload. |
 | `EventKind` | type | `dist/bpmn/bpmn-sdk.d.ts:75-76` | Supporting types | The four non-boundary event element kinds a BpmnNode can be. |
@@ -421,7 +423,7 @@ could hand you spans for a version you do not have.
 | `MessageHandlerOpts` | interface | `dist/bpmn/bpmn-sdk.d.ts:1769-1773` | Option shapes | Options for ActivityBuilder.onMessage. |
 | `OrchestratorAsyncOpts` | interface | `dist/bpmn/bpmn-sdk.d.ts:1279-1286` | Option shapes | Options for the two agentic/case call activities, which come in sync and async forms. |
 | `OrchestratorOpts` | interface | `dist/bpmn/bpmn-sdk.d.ts:1208-1278` | Option shapes | What every Orchestrator invocation needs: which process, in which folder, with what input. |
-| `PathBuilder` | class | `dist/bpmn/bpmn-sdk.d.ts:3158-3220` | Builders | One arm of a `choose` / `fork` / `race`, or one boundary handler's path: the same graph methods as any scope, written… |
+| `PathBuilder` | class | `dist/bpmn/bpmn-sdk.d.ts:3187-3249` | Builders | One arm of a `choose` / `fork` / `race`, or one boundary handler's path: the same graph methods as any scope, written… |
 | `PendingExit` | interface | `dist/bpmn/bpmn-sdk.d.ts:1913-1932` | 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… |
 | `PinnedFlowId` | interface | `dist/bpmn/bpmn-sdk.d.ts:1622-1632` | Supporting types | One implied edge whose id is pinned — see ScopeBuilder.flowIds. |
 | `PlainTaskElement` | type | `dist/bpmn/bpmn-sdk.d.ts:1607-1614` | Supporting types | The BPMN task elements that are legal with NO `uipath:*` payload. |
@@ -429,18 +431,18 @@ could hand you spans for a version you do not have.
 | `ProcessMetadata` | interface | `dist/bpmn/bpmn-sdk.d.ts:514-556` | Supporting types | Process-level metadata — the `uipath:*` children of the process's own `extensionElements` that describe the DOCUMENT… |
 | `QueueItemOpts` | interface | `dist/bpmn/bpmn-sdk.d.ts:1287-1325` | Option shapes | Options for `.queueItem()`. |
 | `ReceiveMessageOpts` | interface | `dist/bpmn/bpmn-sdk.d.ts:1373-1416` | Option shapes | Options for `.receiveMessage()` — `Maestro.ReceiveMessageEvent`. |
-| `RegistryContextField` | interface | `dist/bpmn/typed-node.d.ts:20-40` | Supporting types | One context field of a typed node, as the registry describes it. |
-| `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. |
-| `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. |
-| `RegistryTypeSpec` | interface | `dist/bpmn/typed-node.d.ts:78-96` | Supporting types | One extension type's emission spec. |
+| `RegistryContextField` | interface | `dist/bpmn/typed-node.d.ts:20-47` | Supporting types | One context field of a typed node, as the registry describes it. |
+| `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. |
+| `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. |
+| `RegistryTypeSpec` | interface | `dist/bpmn/typed-node.d.ts:85-108` | Supporting types | One extension type's emission spec. |
 | `RetrySpec` | interface | `dist/bpmn/bpmn-sdk.d.ts:765-807` | Supporting types | Retry an activity that fails (`uipath:retry`). |
 | `SchemaEntry` | interface | `dist/bpmn/bpmn-sdk.d.ts:999-1005` | Supporting types | One entry of BpmnBuilder.schemas — a `.schema()` call written as data. |
-| `ScopeBuilder` | class | `dist/bpmn/bpmn-sdk.d.ts:2028-3113` | Builders | The set of node/flow/variable methods common to the process root and every sub-process. |
+| `ScopeBuilder` | class | `dist/bpmn/bpmn-sdk.d.ts:2028-3142` | Builders | The set of node/flow/variable methods common to the process root and every sub-process. |
 | `ScopeStorage` | interface | `dist/bpmn/bpmn-sdk.d.ts:1933-1946` | Supporting types | The arrays an arm shares with the scope it is written into. |
 | `ScriptTaskOpts` | interface | `dist/bpmn/bpmn-sdk.d.ts:842-956` | Option shapes | Options for `.scriptTask()` — the Jint JavaScript body and its input/output mappings. |
 | `SplitOpts` | interface | `dist/bpmn/bpmn-sdk.d.ts:1828-1834` | Option shapes | Options for ScopeBuilder.fork and ScopeBuilder.race. |
 | `StartOpts` | interface | `dist/bpmn/bpmn-sdk.d.ts:594-684` | Option shapes | Options for `.startEvent()`. |
-| `SubProcessBuilder` | class | `dist/bpmn/bpmn-sdk.d.ts:3139-3157` | Builders | A sub-process body: the same graph methods, plus an internal node builder. |
+| `SubProcessBuilder` | class | `dist/bpmn/bpmn-sdk.d.ts:3168-3186` | Builders | A sub-process body: the same graph methods, plus an internal node builder. |
 | `SubProcessOpts` | interface | `dist/bpmn/bpmn-sdk.d.ts:972-986` | Option shapes | Options for `.subProcess()`. |
 | `SugarRegistry` | class | `dist/bpmn/bpmn-sdk.d.ts:1947-1965` | Supporting types | Bookkeeping the nesting sugar shares across every scope of one process. |
 | `TaskOpts` | interface | `dist/bpmn/bpmn-sdk.d.ts:957-971` | Option shapes | Options for `.task()` — a display name and the variable assignments the task makes. |
@@ -448,10 +450,10 @@ could hand you spans for a version you do not have.
 | `TimerHandlerOpts` | interface | `dist/bpmn/bpmn-sdk.d.ts:1753-1768` | Option shapes | Options for ActivityBuilder.onTimer. |
 | `TimerLike` | type | `dist/bpmn/bpmn-sdk.d.ts:40-41` | Supporting types | A timer as an ISO-8601 duration string (shorthand for `{ duration }`) or a full spec. |
 | `TimerSpec` | interface | `dist/bpmn/bpmn-sdk.d.ts:31-39` | Supporting types | ISO-8601 timer specification (one of duration / date / cycle). |
-| `TypedContextRow` | interface | `dist/bpmn/typed-node.d.ts:155-186` | Supporting types | One `uipath:context` input row, spelled out. |
+| `TypedContextRow` | interface | `dist/bpmn/typed-node.d.ts:167-198` | Supporting types | One `uipath:context` input row, spelled out. |
 | `TypeDesc` | type | `dist/core/expr.d.ts:385` | Supporting types |  |
-| `TypedInputRow` | interface | `dist/bpmn/typed-node.d.ts:187-209` | Supporting types | One `uipath:input` payload row spelled out — the `separateInputs` counterpart of TypedContextRow. |
-| `TypedOutputRow` | interface | `dist/bpmn/typed-node.d.ts:246-285` | Supporting types | 9 field(s) |
+| `TypedInputRow` | interface | `dist/bpmn/typed-node.d.ts:199-221` | Supporting types | One `uipath:input` payload row spelled out — the `separateInputs` counterpart of TypedContextRow. |
+| `TypedOutputRow` | interface | `dist/bpmn/typed-node.d.ts:258-297` | Supporting types | 9 field(s) |
 | `VarDirection` | type | `dist/bpmn/bpmn-sdk.d.ts:361-365` | Supporting types | How a variable is exposed: `'input'` (read-only entry input), `'output'` (a return value), or `'inputOutput'` (a mutable… |
 | `VarEntry` | interface | `dist/bpmn/bpmn-sdk.d.ts:987-998` | Supporting types | One entry of ScopeBuilder.vars — a `.var()` / `.input()` / `.output()` call written as data. |
 | `VarOpts` | interface | `dist/bpmn/bpmn-sdk.d.ts:1642-1715` | Option shapes | Options for `.var()` / `.input()` / `.output()`. |