@uipath/maestro-builder-sdk 6.46.7 → 6.47.1

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.
Files changed (14) hide show
  1. package/dist/api-index.md +71 -69
  2. package/dist/api-members.md +217 -210
  3. package/dist/case/business-event-shape.d.ts +27 -0
  4. package/dist/case/business-event-shape.js +45 -0
  5. package/dist/case/case-sdk.d.ts +64 -3
  6. package/dist/case/case-sdk.js +36 -5
  7. package/dist/case/check.js +31 -1
  8. package/dist/case/decompile.d.ts +7 -0
  9. package/dist/case/decompile.js +39 -1
  10. package/dist/case/preserve.js +1 -1
  11. package/dist/case/rule-options.d.ts +15 -0
  12. package/dist/case/rule-options.js +46 -0
  13. package/dist/case/serialize.js +62 -1
  14. package/package.json +2 -2
package/dist/api-index.md CHANGED
@@ -276,91 +276,93 @@ could hand you spans for a version you do not have.
276
276
 
277
277
  ## `@uipath/maestro-builder-sdk/case`
278
278
 
279
- 81 symbol(s). Import from `@uipath/maestro-builder-sdk/case`.
279
+ 83 symbol(s). Import from `@uipath/maestro-builder-sdk/case`.
280
280
 
281
281
  | Symbol | Kind | Declaration | Area | Summary |
282
282
  | --- | --- | --- | --- | --- |
283
- | `ActionAppRef` | interface | `dist/case/case-sdk.d.ts:494-503` | Supporting types | The Action App an action task opens. |
284
- | `ActionField` | interface | `dist/case/case-sdk.d.ts:463-493` | Supporting types | One field of an Action Center task's form. |
285
- | `ActionSpecData` | interface | `dist/case/case-sdk.d.ts:504-523` | Supporting types | 7 field(s) |
286
- | `BuiltCase` | interface | `dist/case/case-sdk.d.ts:683-708` | Supporting types | 15 field(s) |
287
- | `BuiltCaseExitCondition` | interface | `dist/case/case-sdk.d.ts:370-374` | Supporting types | 3 field(s) |
288
- | `BuiltEntryCondition` | interface | `dist/case/case-sdk.d.ts:312-316` | Supporting types | 3 field(s) |
289
- | `BuiltEscalation` | interface | `dist/case/case-sdk.d.ts:140-142` | Supporting types | A built escalation (the notification an SLA fires). |
290
- | `BuiltExitCondition` | interface | `dist/case/case-sdk.d.ts:337-365` | Supporting types | 6 field(s) |
291
- | `BuiltSla` | interface | `dist/case/case-sdk.d.ts:186-194` | Supporting types | A built SLA rule (`slaRules[]` entry). |
292
- | `BuiltStage` | interface | `dist/case/case-sdk.d.ts:582-591` | Supporting types | 8 field(s) |
293
- | `BuiltTask` | interface | `dist/case/case-sdk.d.ts:557-581` | Supporting types | 16 field(s) |
294
- | `BuiltTaskEntryCondition` | interface | `dist/case/case-sdk.d.ts:366-369` | Supporting types | 2 field(s) |
295
- | `BuiltTrigger` | interface | `dist/case/case-sdk.d.ts:196-209` | Supporting types | 7 field(s) |
296
- | `BusinessRuleOptions` | interface | `dist/case/case-sdk.d.ts:431-450` | Option shapes | Options for TaskBuilder.businessRule. |
297
- | `BusinessRuleSpecData` | interface | `dist/case/case-sdk.d.ts:451-455` | Supporting types | Normalized business-rule configuration stored on a built task. |
298
- | `CaseAppConfig` | interface | `dist/case/case-sdk.d.ts:643-649` | Supporting types | Typed configuration for the generated Case App. |
299
- | `CaseAppDetailValue` | type | `dist/case/case-sdk.d.ts:632-633` | Supporting types | A value displayed in one Case App section. |
300
- | `CaseAppSection` | interface | `dist/case/case-sdk.d.ts:634-642` | Supporting types | One summary section in the generated Case App. |
301
- | `CaseBuilder` | class | `dist/case/case-sdk.d.ts:1133-1376` | Builders | 17 member(s) |
302
- | `CaseLayout` | interface | `dist/case/case-sdk.d.ts:671-682` | Supporting types | Optional Case designer layout, keyed by author-level stage and trigger names. |
303
- | `CaseNodeLayout` | interface | `dist/case/case-sdk.d.ts:650-670` | Supporting types | Designer-only fields the shipped Case transformer moves into `layout.nodes[id]`. |
304
- | `casePlan` | function | `dist/case/case-sdk.d.ts:1377-1383` | Case authoring | Start building a case plan with the given id. |
305
- | `CaseRule` | interface | `dist/case/case-sdk.d.ts:78-81` | Supporting types | A single DNF rule. |
306
- | `CaseRuleGrid` | type | `dist/case/case-sdk.d.ts:113-114` | Supporting types | One rule, one AND-group, or a complete OR-of-AND condition grid. |
307
- | `CaseRuleInput` | type | `dist/case/case-sdk.d.ts:111-112` | Supporting types | A concrete rule or a pure expression gate resolved by its receiving slot. |
283
+ | `ActionAppRef` | interface | `dist/case/case-sdk.d.ts:502-511` | Supporting types | The Action App an action task opens. |
284
+ | `ActionField` | interface | `dist/case/case-sdk.d.ts:471-501` | Supporting types | One field of an Action Center task's form. |
285
+ | `ActionSpecData` | interface | `dist/case/case-sdk.d.ts:512-531` | Supporting types | 7 field(s) |
286
+ | `BuiltBusinessEvent` | interface | `dist/case/case-sdk.d.ts:709-713` | Supporting types | A declared business event, as the serializer reads it. |
287
+ | `BuiltCase` | interface | `dist/case/case-sdk.d.ts:714-741` | Supporting types | 16 field(s) |
288
+ | `BuiltCaseExitCondition` | interface | `dist/case/case-sdk.d.ts:378-382` | Supporting types | 3 field(s) |
289
+ | `BuiltEntryCondition` | interface | `dist/case/case-sdk.d.ts:320-324` | Supporting types | 3 field(s) |
290
+ | `BuiltEscalation` | interface | `dist/case/case-sdk.d.ts:148-150` | Supporting types | A built escalation (the notification an SLA fires). |
291
+ | `BuiltExitCondition` | interface | `dist/case/case-sdk.d.ts:345-373` | Supporting types | 6 field(s) |
292
+ | `BuiltSla` | interface | `dist/case/case-sdk.d.ts:194-202` | Supporting types | A built SLA rule (`slaRules[]` entry). |
293
+ | `BuiltStage` | interface | `dist/case/case-sdk.d.ts:590-599` | Supporting types | 8 field(s) |
294
+ | `BuiltTask` | interface | `dist/case/case-sdk.d.ts:565-589` | Supporting types | 16 field(s) |
295
+ | `BuiltTaskEntryCondition` | interface | `dist/case/case-sdk.d.ts:374-377` | Supporting types | 2 field(s) |
296
+ | `BuiltTrigger` | interface | `dist/case/case-sdk.d.ts:204-217` | Supporting types | 7 field(s) |
297
+ | `BusinessEventOpts` | interface | `dist/case/case-sdk.d.ts:691-708` | Option shapes | Options for CaseBuilder.businessEvent. |
298
+ | `BusinessRuleOptions` | interface | `dist/case/case-sdk.d.ts:439-458` | Option shapes | Options for TaskBuilder.businessRule. |
299
+ | `BusinessRuleSpecData` | interface | `dist/case/case-sdk.d.ts:459-463` | Supporting types | Normalized business-rule configuration stored on a built task. |
300
+ | `CaseAppConfig` | interface | `dist/case/case-sdk.d.ts:651-657` | Supporting types | Typed configuration for the generated Case App. |
301
+ | `CaseAppDetailValue` | type | `dist/case/case-sdk.d.ts:640-641` | Supporting types | A value displayed in one Case App section. |
302
+ | `CaseAppSection` | interface | `dist/case/case-sdk.d.ts:642-650` | Supporting types | One summary section in the generated Case App. |
303
+ | `CaseBuilder` | class | `dist/case/case-sdk.d.ts:1182-1437` | Builders | 18 member(s) |
304
+ | `CaseLayout` | interface | `dist/case/case-sdk.d.ts:679-690` | Supporting types | Optional Case designer layout, keyed by author-level stage and trigger names. |
305
+ | `CaseNodeLayout` | interface | `dist/case/case-sdk.d.ts:658-678` | Supporting types | Designer-only fields the shipped Case transformer moves into `layout.nodes[id]`. |
306
+ | `casePlan` | function | `dist/case/case-sdk.d.ts:1438-1444` | Case authoring | Start building a case plan with the given id. |
307
+ | `CaseRule` | interface | `dist/case/case-sdk.d.ts:86-89` | Supporting types | A single DNF rule. |
308
+ | `CaseRuleGrid` | type | `dist/case/case-sdk.d.ts:121-122` | Supporting types | One rule, one AND-group, or a complete OR-of-AND condition grid. |
309
+ | `CaseRuleInput` | type | `dist/case/case-sdk.d.ts:119-120` | Supporting types | A concrete rule or a pure expression gate resolved by its receiving slot. |
308
310
  | `CaseRuleType` | type | `dist/case/case-sdk.d.ts:27` | Supporting types | |
309
- | `CaseTriggerKind` | type | `dist/case/case-sdk.d.ts:195` | Supporting types | |
310
- | `CaseVarDecl` | interface | `dist/case/case-sdk.d.ts:617-631` | Supporting types | 6 field(s) |
311
+ | `CaseTriggerKind` | type | `dist/case/case-sdk.d.ts:203` | Supporting types | |
312
+ | `CaseVarDecl` | interface | `dist/case/case-sdk.d.ts:625-639` | Supporting types | 6 field(s) |
311
313
  | `ConnectorDescriptor` | type | `dist/core/connectors.d.ts:89-97` | Supporting types | A generated, typed connector descriptor: ConnectorMeta branded with phantom input/output types. |
312
314
  | `ConnectorMeta` | interface | `dist/core/connectors.d.ts:60-88` | Supporting types | Runtime metadata a generated descriptor carries. |
313
315
  | `ConnectorOpts` | interface | `dist/core/actions.d.ts:13-56` | Option shapes | 4 field(s) |
314
- | `ConnectorSpecData` | type | `dist/case/case-sdk.d.ts:394-406` | Supporting types | An Integration Service connector task — the connector variant of the shared `ActionSpec`. |
315
- | `EntryOpts` | interface | `dist/case/case-sdk.d.ts:709-721` | Option shapes | Options common to a stage/task entry condition. |
316
- | `escalation` | function | `dist/case/case-sdk.d.ts:143-149` | Case authoring | Declare an escalation. |
317
- | `EscalationOpts` | interface | `dist/case/case-sdk.d.ts:127-139` | Option shapes | 4 field(s) |
318
- | `EscalationRecipient` | interface | `dist/case/case-sdk.d.ts:119-126` | Supporting types | Who an escalation notifies. |
319
- | `EscalationTrigger` | type | `dist/case/case-sdk.d.ts:117-118` | Supporting types | When an escalation fires: as the deadline approaches (`at-risk`) or once it passes (`sla-breached`). |
316
+ | `ConnectorSpecData` | type | `dist/case/case-sdk.d.ts:402-414` | Supporting types | An Integration Service connector task — the connector variant of the shared `ActionSpec`. |
317
+ | `EntryOpts` | interface | `dist/case/case-sdk.d.ts:742-754` | Option shapes | Options common to a stage/task entry condition. |
318
+ | `escalation` | function | `dist/case/case-sdk.d.ts:151-157` | Case authoring | Declare an escalation. |
319
+ | `EscalationOpts` | interface | `dist/case/case-sdk.d.ts:135-147` | Option shapes | 4 field(s) |
320
+ | `EscalationRecipient` | interface | `dist/case/case-sdk.d.ts:127-134` | Supporting types | Who an escalation notifies. |
321
+ | `EscalationTrigger` | type | `dist/case/case-sdk.d.ts:125-126` | Supporting types | When an escalation fires: as the deadline approaches (`at-risk`) or once it passes (`sla-breached`). |
320
322
  | `EventFilter` | type | `dist/core/actions.d.ts:1076-1117` | Supporting types | One filter condition on the event payload. |
321
323
  | `EventSubscription` | interface | `dist/core/actions.d.ts:1166-1207` | Option shapes | What a connector event subscribes to. |
322
- | `eventTrigger` | function | `dist/case/case-sdk.d.ts:294-304` | Case authoring | An Integration Service **event** trigger — an external event (a new row, an email, a webhook) starts the case. |
323
- | `eventTrigger` | function | `dist/case/case-sdk.d.ts:305-311` | Case authoring | An Integration Service event trigger in placeholder or stringly-resolved form. |
324
- | `EventTriggerOpts` | interface | `dist/case/case-sdk.d.ts:241-281` | Option shapes | 5 field(s) |
325
- | `ExitOpts` | interface | `dist/case/case-sdk.d.ts:722-758` | Option shapes | Options for `stage.exitWhen(rules, opts)` — one call per outcome. |
326
- | `ExternalExecutionMode` | type | `dist/case/case-sdk.d.ts:407-408` | Supporting types | Whether an external Integration Service task blocks for its result or waits for a callback. |
327
- | `ExternalTaskOptions` | interface | `dist/case/case-sdk.d.ts:409-419` | Option shapes | Required wiring and typed inputs for an external agent/workflow invocation. |
328
- | `ExternalTaskSpecData` | interface | `dist/case/case-sdk.d.ts:420-426` | Supporting types | Normalized descriptor and execution mode stored on a built external task. |
329
- | `jsonSchema` | function | `dist/case/case-sdk.d.ts:601-616` | Case authoring | Declare a structured (object/array) variable type. |
330
- | `JsonSchemaType` | interface | `dist/case/case-sdk.d.ts:592-600` | Supporting types | A structured (object/array) variable type + its JSON-schema `body`, as returned by jsonSchema. |
324
+ | `eventTrigger` | function | `dist/case/case-sdk.d.ts:302-312` | Case authoring | An Integration Service **event** trigger — an external event (a new row, an email, a webhook) starts the case. |
325
+ | `eventTrigger` | function | `dist/case/case-sdk.d.ts:313-319` | Case authoring | An Integration Service event trigger in placeholder or stringly-resolved form. |
326
+ | `EventTriggerOpts` | interface | `dist/case/case-sdk.d.ts:249-289` | Option shapes | 5 field(s) |
327
+ | `ExitOpts` | interface | `dist/case/case-sdk.d.ts:755-791` | Option shapes | Options for `stage.exitWhen(rules, opts)` — one call per outcome. |
328
+ | `ExternalExecutionMode` | type | `dist/case/case-sdk.d.ts:415-416` | Supporting types | Whether an external Integration Service task blocks for its result or waits for a callback. |
329
+ | `ExternalTaskOptions` | interface | `dist/case/case-sdk.d.ts:417-427` | Option shapes | Required wiring and typed inputs for an external agent/workflow invocation. |
330
+ | `ExternalTaskSpecData` | interface | `dist/case/case-sdk.d.ts:428-434` | Supporting types | Normalized descriptor and execution mode stored on a built external task. |
331
+ | `jsonSchema` | function | `dist/case/case-sdk.d.ts:609-624` | Case authoring | Declare a structured (object/array) variable type. |
332
+ | `JsonSchemaType` | interface | `dist/case/case-sdk.d.ts:600-608` | Supporting types | A structured (object/array) variable type + its JSON-schema `body`, as returned by jsonSchema. |
331
333
  | `LookupSpec` | interface | `dist/core/lookups.d.ts:11-36` | Supporting types | One lookup field's retrieval contract, generated from `reference`. |
332
334
  | `LookupStrategy` | type | `dist/core/lookups.d.ts:1-10` | Supporting types | How `prepare` should retrieve the collection, chosen from the metadata. |
333
335
  | `LookupToken` | interface | `dist/core/lookups.d.ts:37-52` | Supporting types | An unresolved lookup: what `.byEmail(…)` returns. |
334
- | `manualTrigger` | function | `dist/case/case-sdk.d.ts:227-233` | Case authoring | A manual (user-initiated) case trigger. |
335
- | `ManualTriggerOpts` | interface | `dist/case/case-sdk.d.ts:210-213` | Option shapes | 2 field(s) |
336
- | `RecipientType` | type | `dist/case/case-sdk.d.ts:456-462` | Supporting types | Action-task recipient type. |
337
- | `ResolvedEventTriggerOpts` | interface | `dist/case/case-sdk.d.ts:282-293` | Option shapes | Options for the typed `eventTrigger(Descriptor, options)` form. |
338
- | `rule` | function | `dist/case/case-sdk.d.ts:82-91` | Case authoring | Declare a condition rule. |
339
- | `RuleOpts` | interface | `dist/case/case-sdk.d.ts:28-77` | Option shapes | 6 field(s) |
340
- | `SelectNextStageSpec` | interface | `dist/case/case-sdk.d.ts:318-336` | Supporting types | Data Fabric entity used by the Case runtime to deliver a person's next-stage selection. |
341
- | `SlaOpts` | interface | `dist/case/case-sdk.d.ts:166-185` | Option shapes | 5 field(s) |
342
- | `SlaUnit` | type | `dist/case/case-sdk.d.ts:115-116` | Supporting types | SLA deadline unit. |
343
- | `StageBuilder` | class | `dist/case/case-sdk.d.ts:1055-1132` | Builders | 6 member(s) |
344
- | `StageExitType` | type | `dist/case/case-sdk.d.ts:317` | Supporting types | |
345
- | `TaskBuilder` | class | `dist/case/case-sdk.d.ts:759-1054` | Builders | 24 member(s) |
346
- | `TaskInputBinding` | interface | `dist/case/case-sdk.d.ts:538-545` | Supporting types | A task input binding: a resource input parameter set to a literal or a `=`-expression. |
347
- | `TaskKind` | type | `dist/case/case-sdk.d.ts:375` | Supporting types | |
348
- | `TaskOutputBinding` | interface | `dist/case/case-sdk.d.ts:546-556` | Supporting types | A task output extraction: bind a field of the task's result (`source`) into a case variable (`var`) that later… |
349
- | `TaskRef` | interface | `dist/case/case-sdk.d.ts:427-430` | Supporting types | 2 field(s) |
350
- | `TimerSpecData` | type | `dist/case/case-sdk.d.ts:524-537` | Supporting types | Exactly one product-supported timer value. |
351
- | `timerTrigger` | function | `dist/case/case-sdk.d.ts:234-240` | Case authoring | A timer (scheduled) case trigger. |
352
- | `TimerTriggerOpts` | interface | `dist/case/case-sdk.d.ts:214-226` | Option shapes | 3 field(s) |
353
- | `toGroup` | function | `dist/case/case-sdk.d.ts:158-165` | Case authoring | An escalation recipient that is a user group. |
354
- | `toUser` | function | `dist/case/case-sdk.d.ts:150-157` | Case authoring | An escalation recipient that is a single user. |
336
+ | `manualTrigger` | function | `dist/case/case-sdk.d.ts:235-241` | Case authoring | A manual (user-initiated) case trigger. |
337
+ | `ManualTriggerOpts` | interface | `dist/case/case-sdk.d.ts:218-221` | Option shapes | 2 field(s) |
338
+ | `RecipientType` | type | `dist/case/case-sdk.d.ts:464-470` | Supporting types | Action-task recipient type. |
339
+ | `ResolvedEventTriggerOpts` | interface | `dist/case/case-sdk.d.ts:290-301` | Option shapes | Options for the typed `eventTrigger(Descriptor, options)` form. |
340
+ | `rule` | function | `dist/case/case-sdk.d.ts:90-99` | Case authoring | Declare a condition rule. |
341
+ | `RuleOpts` | interface | `dist/case/case-sdk.d.ts:28-85` | Option shapes | 7 field(s) |
342
+ | `SelectNextStageSpec` | interface | `dist/case/case-sdk.d.ts:326-344` | Supporting types | Data Fabric entity used by the Case runtime to deliver a person's next-stage selection. |
343
+ | `SlaOpts` | interface | `dist/case/case-sdk.d.ts:174-193` | Option shapes | 5 field(s) |
344
+ | `SlaUnit` | type | `dist/case/case-sdk.d.ts:123-124` | Supporting types | SLA deadline unit. |
345
+ | `StageBuilder` | class | `dist/case/case-sdk.d.ts:1104-1181` | Builders | 6 member(s) |
346
+ | `StageExitType` | type | `dist/case/case-sdk.d.ts:325` | Supporting types | |
347
+ | `TaskBuilder` | class | `dist/case/case-sdk.d.ts:792-1103` | Builders | 25 member(s) |
348
+ | `TaskInputBinding` | interface | `dist/case/case-sdk.d.ts:546-553` | Supporting types | A task input binding: a resource input parameter set to a literal or a `=`-expression. |
349
+ | `TaskKind` | type | `dist/case/case-sdk.d.ts:383` | Supporting types | |
350
+ | `TaskOutputBinding` | interface | `dist/case/case-sdk.d.ts:554-564` | Supporting types | A task output extraction: bind a field of the task's result (`source`) into a case variable (`var`) that later… |
351
+ | `TaskRef` | interface | `dist/case/case-sdk.d.ts:435-438` | Supporting types | 2 field(s) |
352
+ | `TimerSpecData` | type | `dist/case/case-sdk.d.ts:532-545` | Supporting types | Exactly one product-supported timer value. |
353
+ | `timerTrigger` | function | `dist/case/case-sdk.d.ts:242-248` | Case authoring | A timer (scheduled) case trigger. |
354
+ | `TimerTriggerOpts` | interface | `dist/case/case-sdk.d.ts:222-234` | Option shapes | 3 field(s) |
355
+ | `toGroup` | function | `dist/case/case-sdk.d.ts:166-173` | Case authoring | An escalation recipient that is a user group. |
356
+ | `toUser` | function | `dist/case/case-sdk.d.ts:158-165` | Case authoring | An escalation recipient that is a single user. |
355
357
  | `TriggerDescriptor` | type | `dist/core/connectors.d.ts:130-138` | Supporting types | A generated, typed connector-trigger descriptor: TriggerMeta branded with phantom `where`/output types. |
356
358
  | `TriggerMeta` | interface | `dist/core/connectors.d.ts:120-129` | Supporting types | Runtime metadata a generated trigger descriptor carries. |
357
359
  | `TriggerOptions` | interface | `dist/core/actions.d.ts:1118-1165` | Option shapes | The typed `onEvent`/`waitForEvent` options — everything an EventSubscription carries except `connector`/`event`, which… |
358
360
  | `TypeDesc` | type | `dist/core/expr.d.ts:385` | Supporting types | |
359
- | `UnresolvedReferenceTaskKind` | type | `dist/case/case-sdk.d.ts:376-377` | Supporting types | Published-resource task kinds that the Case schema permits as unresolved skeletons. |
360
- | `WaitConnectorPlaceholderSpec` | interface | `dist/case/case-sdk.d.ts:378-388` | Supporting types | A `wait-for-connector` subscription: suspend on an Integration Service event. |
361
- | `WaitConnectorSpec` | type | `dist/case/case-sdk.d.ts:389-393` | Supporting types | A placeholder connector/operation pair, or a library-resolved event subscription using the same symbolic shape as Flow… |
362
- | `when` | function | `dist/case/case-sdk.d.ts:104-110` | Case authoring | Gate a condition slot only on case data without naming its default event. |
363
- | `WhenExpression` | interface | `dist/case/case-sdk.d.ts:92-103` | Supporting types | A pure expression gate. |
361
+ | `UnresolvedReferenceTaskKind` | type | `dist/case/case-sdk.d.ts:384-385` | Supporting types | Published-resource task kinds that the Case schema permits as unresolved skeletons. |
362
+ | `WaitConnectorPlaceholderSpec` | interface | `dist/case/case-sdk.d.ts:386-396` | Supporting types | A `wait-for-connector` subscription: suspend on an Integration Service event. |
363
+ | `WaitConnectorSpec` | type | `dist/case/case-sdk.d.ts:397-401` | Supporting types | A placeholder connector/operation pair, or a library-resolved event subscription using the same symbolic shape as Flow… |
364
+ | `when` | function | `dist/case/case-sdk.d.ts:112-118` | Case authoring | Gate a condition slot only on case data without naming its default event. |
365
+ | `WhenExpression` | interface | `dist/case/case-sdk.d.ts:100-111` | Supporting types | A pure expression gate. |
364
366
 
365
367
  ## `@uipath/maestro-builder-sdk/bpmn`
366
368