@uipath/maestro-builder-sdk 6.36.0 → 6.37.0

package/dist/api-index.md

@@ -37,7 +37,7 @@ could hand you spans for a version you do not have.
 
 ## `@uipath/maestro-builder-sdk`
 
-230 symbol(s). Import from `@uipath/maestro-builder-sdk`.
+231 symbol(s). Import from `@uipath/maestro-builder-sdk`.
 
 | Symbol | Kind | Declaration | Area | Summary |
 | --- | --- | --- | --- | --- |
@@ -180,15 +180,15 @@ could hand you spans for a version you do not have.
 | `js` | function | `dist/core/expr.d.ts:247-282` | Expressions and types | Build a raw JS *expression* (a condition or computation). |
 | `lit` | function | `dist/core/expr.d.ts:22-28` | Expressions and types | A constant value baked directly into a node input. |
 | `lookup` | function | `dist/core/lookups.d.ts:95-102` | Generated descriptors | Begin resolving a lookup field on a generated descriptor. |
-| `lookup` | function | `dist/core/lookups.d.ts:103-122` | Generated descriptors | Begin resolving a lookup field addressed by connector key and action. |
-| `lookup` | function | `dist/core/lookups.d.ts:123-137` | Generated descriptors | Begin resolving a `where` parameter on a trigger descriptor that carries a lookup table. |
-| `lookup` | function | `dist/core/lookups.d.ts:138-159` | Generated descriptors | Begin resolving a `where` parameter on a connector-EVENT descriptor. |
+| `lookup` | function | `dist/core/lookups.d.ts:103-127` | Generated descriptors | Begin resolving a lookup field addressed by connector key and action. |
+| `lookup` | function | `dist/core/lookups.d.ts:128-142` | Generated descriptors | Begin resolving a `where` parameter on a trigger descriptor that carries a lookup table. |
+| `lookup` | function | `dist/core/lookups.d.ts:143-164` | Generated descriptors | Begin resolving a `where` parameter on a connector-EVENT descriptor. |
 | `LookupBuilder` | type | `dist/core/lookups.d.ts:64-71` | Generated descriptors | What `lookup(...)` returns: the generic form plus any generated aliases. |
 | `lookupKey` | function | `dist/core/lookups.d.ts:55-63` | Generated descriptors | The identity of one resolution, as `prepare` records it and `compile` reads it. |
-| `LookupResolution` | interface | `dist/core/lookups.d.ts:160-169` | Generated descriptors | One recorded resolution, as `connectors-local/resolutions.json` stores it. |
-| `LookupResolutions` | type | `dist/core/lookups.d.ts:170-171` | Generated descriptors | Every recorded resolution, keyed by lookupKey. |
+| `LookupResolution` | interface | `dist/core/lookups.d.ts:165-174` | Generated descriptors | One recorded resolution, as `connectors-local/resolutions.json` stores it. |
+| `LookupResolutions` | type | `dist/core/lookups.d.ts:175-176` | Generated descriptors | Every recorded resolution, keyed by lookupKey. |
 | `LookupSpec` | interface | `dist/core/lookups.d.ts:11-36` | Generated descriptors | One lookup field's retrieval contract, generated from `reference`. |
-| `lookupSpecOf` | function | `dist/core/lookups.d.ts:199-206` | Generated descriptors | The LookupSpec for one field, or `undefined` when it earns no helper. |
+| `lookupSpecOf` | function | `dist/core/lookups.d.ts:221-228` | Generated descriptors | The LookupSpec for one field, or `undefined` when it earns no helper. |
 | `LookupStrategy` | type | `dist/core/lookups.d.ts:1-10` | Generated descriptors | How `prepare` should retrieve the collection, chosen from the metadata. |
 | `LookupToken` | interface | `dist/core/lookups.d.ts:37-52` | Generated descriptors | An unresolved lookup: what `.byEmail(…)` returns. |
 | `LoopOptions` | interface | `dist/flow-sdk.d.ts:487-511` | Option shapes | Loop-specific options. |
@@ -214,10 +214,11 @@ could hand you spans for a version you do not have.
 | `QueuePriority` | type | `dist/nodes/queue/flow/spec.d.ts:9-10` | Supporting types | The three priorities an Orchestrator queue item can carry. |
 | `ran` | function | `dist/core/expr.d.ts:95-141` | Expressions and types | Did this step run? |
 | `rawNode` | function | `dist/raw-node.d.ts:9-71` | Supporting types | Place a node this SDK has no factory for, carrying its definition verbatim (`uipath.exotic.thing@2.1` and the manifest… |
-| `RawReference` | type | `dist/core/lookups.d.ts:190-198` | Supporting types |  |
+| `RawReference` | type | `dist/core/lookups.d.ts:212-220` | Supporting types |  |
 | `RemoteA2aToolRef` | interface | `dist/core/actions.d.ts:1285-1305` | Supporting types | A remote A2A (agent-to-agent) endpoint the agent may delegate to. |
-| `resolvedValue` | function | `dist/core/lookups.d.ts:172-179` | Generated descriptors | The recorded id for a token, or `undefined`. |
-| `resolveEventWhere` | function | `dist/core/lookups.d.ts:207-224` | Generated descriptors | An event subscription's `where` with every lookup token swapped for the id `registry prepare --resolve` recorded, or a… |
+| `resolvedEventValue` | function | `dist/core/lookups.d.ts:185-201` | Generated descriptors | resolvedValue for a token on an event's `where`. |
+| `resolvedValue` | function | `dist/core/lookups.d.ts:177-184` | Generated descriptors | The recorded id for a token, or `undefined`. |
+| `resolveEventWhere` | function | `dist/core/lookups.d.ts:229-246` | Generated descriptors | An event subscription's `where` with every lookup token swapped for the id `registry prepare --resolve` recorded, or a… |
 | `ReturnFieldType` | type | `dist/core/actions.d.ts:821-838` | Supporting types | A JSON-schema-ish type for one field of a step's declared `returns`. |
 | `ReturnOptions` | interface | `dist/flow-sdk.d.ts:445-486` | Option shapes | `.return(...)`-specific options. |
 | `rpaWorkflow` | function | `dist/core/actions.d.ts:1797-1841` | Actions | Invoke a deployed RPA (robotic process automation) workflow — a classic UI-automation process, published to… |
@@ -259,7 +260,7 @@ could hand you spans for a version you do not have.
 | `TriggerSpec` | type | `dist/flow-sdk.d.ts:162-180` | Supporting types | What starts the flow. |
 | `TypeDesc` | type | `dist/core/expr.d.ts:385` | Supporting types |  |
 | `types` | const | `dist/core/expr.d.ts:369-384` | Expressions and types | Variable type descriptors (map to Flow variable `type` values). |
-| `unresolvedLookupMessage` | function | `dist/core/lookups.d.ts:180-189` | Generated descriptors | The message for a lookup nothing has resolved — the command that fixes it. |
+| `unresolvedLookupMessage` | function | `dist/core/lookups.d.ts:202-211` | Generated descriptors | The message for a lookup nothing has resolved — the command that fixes it. |
 | `v` | function | `dist/core/expr.d.ts:29-41` | Expressions and types | Reference a flow variable or output by name → `$vars.<name>`. |
 | `VarDecl` | interface | `dist/flow-sdk.d.ts:59-71` | Supporting types | 7 field(s) |
 | `VarSpec` | interface | `dist/flow-sdk.d.ts:72-127` | Supporting types | The rich spelling of a variable declaration: pass it instead of a bare `types.*` descriptor wherever `.input()` /… |
@@ -366,7 +367,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… |
@@ -376,9 +377,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. |
@@ -399,8 +400,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. |
@@ -423,7 +424,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. |
@@ -431,18 +432,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. |
@@ -450,10 +451,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()`. |