@uipath/maestro-builder-sdk 6.47.0 → 6.47.2
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 +32 -32
- package/dist/api-members.md +156 -155
- package/dist/case/case-sdk.d.ts +49 -8
- package/dist/case/case-sdk.js +22 -7
- package/dist/case/check.js +10 -3
- package/dist/case/decompile.js +74 -59
- package/dist/case/external.d.ts +41 -2
- package/dist/case/external.js +56 -2
- package/dist/case/serialize.js +34 -59
- package/package.json +2 -2
package/dist/case/case-sdk.d.ts
CHANGED
|
@@ -380,9 +380,9 @@ export interface BuiltCaseExitCondition {
|
|
|
380
380
|
marksCaseComplete?: boolean;
|
|
381
381
|
rules: CaseRule[][];
|
|
382
382
|
}
|
|
383
|
-
export type TaskKind = 'process' | 'agent' | 'rpa' | 'api-workflow' | 'case-management' | 'flow-process' | 'business-rule' | 'external-agent' | 'external-workflow' | 'action' | 'connector' | 'wait-for-timer' | 'wait-for-connector';
|
|
383
|
+
export type TaskKind = 'process' | 'agent' | 'rpa' | 'api-workflow' | 'case-management' | 'flow-process' | 'function' | 'business-rule' | 'external-agent' | 'external-workflow' | 'action' | 'connector' | 'wait-for-timer' | 'wait-for-connector';
|
|
384
384
|
/** Published-resource task kinds that the Case schema permits as unresolved skeletons. */
|
|
385
|
-
export type UnresolvedReferenceTaskKind = 'process' | 'agent' | 'rpa' | 'api-workflow' | 'case-management';
|
|
385
|
+
export type UnresolvedReferenceTaskKind = 'process' | 'agent' | 'rpa' | 'api-workflow' | 'case-management' | 'function';
|
|
386
386
|
/**
|
|
387
387
|
* A `wait-for-connector` subscription: suspend on an Integration Service event.
|
|
388
388
|
* Omit `connectorKey`/`operation` for a bare **placeholder** (for a connector not
|
|
@@ -412,22 +412,47 @@ export type WaitConnectorSpec = WaitConnectorPlaceholderSpec | EventSubscription
|
|
|
412
412
|
export type ConnectorSpecData = Extract<ActionSpec, {
|
|
413
413
|
kind: 'connector';
|
|
414
414
|
}>;
|
|
415
|
-
/**
|
|
416
|
-
|
|
415
|
+
/**
|
|
416
|
+
* The external agent's or automation's `executionType`, as Integration Service
|
|
417
|
+
* reports it for the connector object.
|
|
418
|
+
*
|
|
419
|
+
* @remarks
|
|
420
|
+
* This is a property of the connector object, not a choice about the case: copy
|
|
421
|
+
* it from the activity's `case spec` result
|
|
422
|
+
* (`Data.EssentialConfiguration.essentialConfiguration.executionType`). The Case
|
|
423
|
+
* Designer saves `sync` as the `Sync…Execution` service type and both `async`
|
|
424
|
+
* and `hybrid` as `Async…Execution`, and writes the value itself into the task's
|
|
425
|
+
* `executionType` context.
|
|
426
|
+
*
|
|
427
|
+
* `hybrid` is refused for now (EXTERNAL_TASK_HYBRID_UNSUPPORTED): the Designer
|
|
428
|
+
* also writes an event pair for it (`operation`, `eventMode`) that the connector
|
|
429
|
+
* library does not carry (#1387). Add a task on a hybrid object in Studio Web.
|
|
430
|
+
*
|
|
431
|
+
* It does not decide whether the stage waits for the task. A task the stage must
|
|
432
|
+
* not wait on is `.required(false)`, whatever its execution type. For example, a
|
|
433
|
+
* Snowflake Cortex Interact Agent is `sync` even when the stage moves on without
|
|
434
|
+
* it.
|
|
435
|
+
*/
|
|
436
|
+
export type ExternalExecutionMode = 'sync' | 'async' | 'hybrid';
|
|
417
437
|
/** Required wiring and typed inputs for an external agent/workflow invocation. */
|
|
418
438
|
export interface ExternalTaskOptions<I extends Record<string, unknown>> {
|
|
419
439
|
/** Symbolic Integration Service connection name declared in `bindings.json`. */
|
|
420
440
|
connection: string;
|
|
421
441
|
/** Symbolic Orchestrator folder binding name declared in `bindings.json`. */
|
|
422
442
|
folder: string;
|
|
423
|
-
/**
|
|
443
|
+
/**
|
|
444
|
+
* The connector object's `executionType` from its `case spec` result. Required:
|
|
445
|
+
* the connector library does not carry it yet (#1369), and a wrong value passes
|
|
446
|
+
* `validate` but runs the wrong contract. Not whether the stage waits: that is
|
|
447
|
+
* `.required(false)`. See {@link ExternalExecutionMode}.
|
|
448
|
+
*/
|
|
424
449
|
mode: ExternalExecutionMode;
|
|
425
450
|
/** Inputs statically checked by the generated connector descriptor. */
|
|
426
451
|
inputs: I;
|
|
427
452
|
}
|
|
428
453
|
/** Normalized descriptor and execution mode stored on a built external task. */
|
|
429
454
|
export interface ExternalTaskSpecData {
|
|
430
|
-
/**
|
|
455
|
+
/** The connector object's `executionType`. */
|
|
431
456
|
mode: ExternalExecutionMode;
|
|
432
457
|
/** Shared connector action identity, inputs, and symbolic bindings. */
|
|
433
458
|
connector: ConnectorSpecData;
|
|
@@ -884,6 +909,22 @@ declare class TaskBuilder {
|
|
|
884
909
|
flowProcess(name: string, opts?: {
|
|
885
910
|
folder?: string;
|
|
886
911
|
}): this;
|
|
912
|
+
/**
|
|
913
|
+
* Reference a deployed **Coded Function** (a `uipath-functions` project).
|
|
914
|
+
*
|
|
915
|
+
* @remarks
|
|
916
|
+
* Emits a `function` task bound like the other published resources, with
|
|
917
|
+
* `resourceSubType: 'Function'`. A function is its own task type: do not
|
|
918
|
+
* model one as `.apiWorkflow()` or `.agent()`. A function with several
|
|
919
|
+
* deployments of one name is told apart by its folder.
|
|
920
|
+
*
|
|
921
|
+
* @param name - The deployed function's name.
|
|
922
|
+
* @param opts - `folder` — the Orchestrator folder it lives in, or `'solution_folder'` (the default when omitted) for one built in this solution. Compile binds the task through a name/folderPath pair of root bindings keyed `<folder>.<name>`.
|
|
923
|
+
* @returns This builder, so calls chain.
|
|
924
|
+
*/
|
|
925
|
+
function(name: string, opts?: {
|
|
926
|
+
folder?: string;
|
|
927
|
+
}): this;
|
|
887
928
|
/**
|
|
888
929
|
* Evaluate a deployed **business rule** (a DMN decision package) and read its
|
|
889
930
|
* decisions back.
|
|
@@ -918,7 +959,7 @@ declare class TaskBuilder {
|
|
|
918
959
|
* Invoke an external agent through its generated Integration Service descriptor.
|
|
919
960
|
*
|
|
920
961
|
* @param descriptor - An `AgentExecution` operation from a generated connector module.
|
|
921
|
-
* @param opts - Required connection/folder bindings,
|
|
962
|
+
* @param opts - Required connection/folder bindings, the object's execution type, and descriptor-typed inputs.
|
|
922
963
|
* @returns This builder, so calls chain.
|
|
923
964
|
*/
|
|
924
965
|
externalAgent<I extends Record<string, unknown>, O>(descriptor: ConnectorDescriptor<I, O>, opts: ExternalTaskOptions<I>): this;
|
|
@@ -926,7 +967,7 @@ declare class TaskBuilder {
|
|
|
926
967
|
* Invoke an external workflow through its generated Integration Service descriptor.
|
|
927
968
|
*
|
|
928
969
|
* @param descriptor - A `ProcessExecution` operation from a generated connector module.
|
|
929
|
-
* @param opts - Required connection/folder bindings,
|
|
970
|
+
* @param opts - Required connection/folder bindings, the object's execution type, and descriptor-typed inputs.
|
|
930
971
|
* @returns This builder, so calls chain.
|
|
931
972
|
*/
|
|
932
973
|
externalWorkflow<I extends Record<string, unknown>, O>(descriptor: ConnectorDescriptor<I, O>, opts: ExternalTaskOptions<I>): this;
|
package/dist/case/case-sdk.js
CHANGED
|
@@ -264,6 +264,22 @@ class TaskBuilder {
|
|
|
264
264
|
flowProcess(name, opts) {
|
|
265
265
|
return this.reference('flow-process', name, opts);
|
|
266
266
|
}
|
|
267
|
+
/**
|
|
268
|
+
* Reference a deployed **Coded Function** (a `uipath-functions` project).
|
|
269
|
+
*
|
|
270
|
+
* @remarks
|
|
271
|
+
* Emits a `function` task bound like the other published resources, with
|
|
272
|
+
* `resourceSubType: 'Function'`. A function is its own task type: do not
|
|
273
|
+
* model one as `.apiWorkflow()` or `.agent()`. A function with several
|
|
274
|
+
* deployments of one name is told apart by its folder.
|
|
275
|
+
*
|
|
276
|
+
* @param name - The deployed function's name.
|
|
277
|
+
* @param opts - `folder` — the Orchestrator folder it lives in, or `'solution_folder'` (the default when omitted) for one built in this solution. Compile binds the task through a name/folderPath pair of root bindings keyed `<folder>.<name>`.
|
|
278
|
+
* @returns This builder, so calls chain.
|
|
279
|
+
*/
|
|
280
|
+
function(name, opts) {
|
|
281
|
+
return this.reference('function', name, opts);
|
|
282
|
+
}
|
|
267
283
|
/**
|
|
268
284
|
* Evaluate a deployed **business rule** (a DMN decision package) and read its
|
|
269
285
|
* decisions back.
|
|
@@ -312,7 +328,7 @@ class TaskBuilder {
|
|
|
312
328
|
* Invoke an external agent through its generated Integration Service descriptor.
|
|
313
329
|
*
|
|
314
330
|
* @param descriptor - An `AgentExecution` operation from a generated connector module.
|
|
315
|
-
* @param opts - Required connection/folder bindings,
|
|
331
|
+
* @param opts - Required connection/folder bindings, the object's execution type, and descriptor-typed inputs.
|
|
316
332
|
* @returns This builder, so calls chain.
|
|
317
333
|
*/
|
|
318
334
|
externalAgent(descriptor, opts) {
|
|
@@ -322,7 +338,7 @@ class TaskBuilder {
|
|
|
322
338
|
* Invoke an external workflow through its generated Integration Service descriptor.
|
|
323
339
|
*
|
|
324
340
|
* @param descriptor - A `ProcessExecution` operation from a generated connector module.
|
|
325
|
-
* @param opts - Required connection/folder bindings,
|
|
341
|
+
* @param opts - Required connection/folder bindings, the object's execution type, and descriptor-typed inputs.
|
|
326
342
|
* @returns This builder, so calls chain.
|
|
327
343
|
*/
|
|
328
344
|
externalWorkflow(descriptor, opts) {
|
|
@@ -488,12 +504,11 @@ class TaskBuilder {
|
|
|
488
504
|
_build() {
|
|
489
505
|
if (!this._kind)
|
|
490
506
|
throw new Error(`task "${this._name}" has no kind — call .process()/.agent()/.rpa()/.action()/.connector()/.waitForTimer()/… once.`);
|
|
491
|
-
// Task I/O binding is reference-mode only
|
|
492
|
-
//
|
|
493
|
-
|
|
494
|
-
const REF_IO = new Set(['process', 'agent', 'rpa', 'api-workflow', 'case-management', 'flow-process', 'business-rule']);
|
|
507
|
+
// Task I/O binding is reference-mode only (REF_IO). Connector tasks derive
|
|
508
|
+
// their own inputs/outputs from the operation schema.
|
|
509
|
+
const REF_IO = new Set(['process', 'agent', 'rpa', 'api-workflow', 'case-management', 'flow-process', 'function', 'business-rule']);
|
|
495
510
|
if ((this._inputs || this._outputs) && !REF_IO.has(this._kind))
|
|
496
|
-
throw new Error(`task "${this._name}": .inputs()/.outputs() are only supported on reference-mode tasks (process/agent/rpa/api-workflow/case-management/flow-process/business-rule), not "${this._kind}".`);
|
|
511
|
+
throw new Error(`task "${this._name}": .inputs()/.outputs() are only supported on reference-mode tasks (process/agent/rpa/api-workflow/case-management/flow-process/function/business-rule), not "${this._kind}".`);
|
|
497
512
|
if (!this._ref && (this._inputs || this._outputs))
|
|
498
513
|
throw new Error(`task "${this._name}": an unresolved reference task cannot declare inputs or outputs.`);
|
|
499
514
|
return {
|
package/dist/case/check.js
CHANGED
|
@@ -6,7 +6,7 @@ import { schemaVersionRefusal } from '../schema-version.js';
|
|
|
6
6
|
import { caseJsonPreservation, caseJsonPreservationErrors } from './preserve.js';
|
|
7
7
|
import { EQUALS_EXPR_DIALECT, checkBindingLabels, checkConnectorContract, checkConnectorLookups, checkConnectorSchema, } from '../core/connector-checks.js';
|
|
8
8
|
import { checkEventResolution } from '../core/event-checks.js';
|
|
9
|
-
import { EXTERNAL_TASK_DESCRIPTOR_CONTRACT } from './external.js';
|
|
9
|
+
import { EXTERNAL_TASK_DESCRIPTOR_CONTRACT, EXTERNAL_TASK_HYBRID_UNSUPPORTED, externalHybridRefusal, isExternalExecutionMode } from './external.js';
|
|
10
10
|
import { isResourceLabelRefusal, resolveResourceRef } from './resource-identity.js';
|
|
11
11
|
const TYPE_NAMES = new Set(Object.values(types));
|
|
12
12
|
// audit-case-coverage: rule-slot table start
|
|
@@ -571,11 +571,18 @@ function checkStage(stage, diags, refStage, refPlacement, bindings) {
|
|
|
571
571
|
where: t.name,
|
|
572
572
|
});
|
|
573
573
|
else {
|
|
574
|
-
if (t.external.mode
|
|
574
|
+
if (!isExternalExecutionMode(t.external.mode))
|
|
575
575
|
diags.push({
|
|
576
576
|
level: 'error',
|
|
577
577
|
code: 'EXTERNAL_TASK_MODE',
|
|
578
|
-
message: `${family} task "${t.name}" mode must be "sync"
|
|
578
|
+
message: `${family} task "${t.name}" mode must be the connector object's executionType: "sync", "async" or "hybrid".`,
|
|
579
|
+
where: t.name,
|
|
580
|
+
});
|
|
581
|
+
else if (t.external.mode === 'hybrid')
|
|
582
|
+
diags.push({
|
|
583
|
+
level: 'error',
|
|
584
|
+
code: EXTERNAL_TASK_HYBRID_UNSUPPORTED,
|
|
585
|
+
message: externalHybridRefusal(`${family} task "${t.name}"`),
|
|
579
586
|
where: t.name,
|
|
580
587
|
});
|
|
581
588
|
if (!t.external.connector?.key?.trim() || !t.external.connector?.action?.trim())
|
package/dist/case/decompile.js
CHANGED
|
@@ -1,6 +1,7 @@
|
|
|
1
1
|
import { commentText } from '../core/comment-text.js';
|
|
2
2
|
import { tsLiteral, tsNumber } from '../core/ts-literal.js';
|
|
3
3
|
import { CASE_FORMAT_PROFILE, CASE_SCHEMA_VERSIONS } from './format-profile.js';
|
|
4
|
+
import { EXTERNAL_TASK_CONTEXT, externalDescriptorRefusal, externalHybridRefusal, externalServiceType, isExternalExecutionMode } from './external.js';
|
|
4
5
|
import { preserveSchemaVersion } from '../schema-version.js';
|
|
5
6
|
import { ownEntry } from '../core/own-entry.js';
|
|
6
7
|
import { isUnrestorableSlotId } from './preserve.js';
|
|
@@ -13,6 +14,7 @@ const TASK_KIND_METHOD = {
|
|
|
13
14
|
'api-workflow': 'apiWorkflow',
|
|
14
15
|
'case-management': 'caseManagement',
|
|
15
16
|
'flow-process': 'flowProcess',
|
|
17
|
+
function: 'function',
|
|
16
18
|
};
|
|
17
19
|
function boolLit(value) {
|
|
18
20
|
return value ? 'true' : 'false';
|
|
@@ -522,6 +524,42 @@ function connectorVersion(context) {
|
|
|
522
524
|
function toCamel(value) {
|
|
523
525
|
return value.replace(/_([a-z0-9])/gi, (_match, char) => String(char).toUpperCase());
|
|
524
526
|
}
|
|
527
|
+
/**
|
|
528
|
+
* A connector activity's authored inputs, lifted from its `pathParameters` /
|
|
529
|
+
* `queryParameters` / `body` input containers. A `body` key is the authored
|
|
530
|
+
* name; a path or query key is the camelCased wire name, mapped back to the
|
|
531
|
+
* operation's parameter name. Shared by the plain connector lift and the
|
|
532
|
+
* external task lift, so the two cannot drift.
|
|
533
|
+
*
|
|
534
|
+
* With `owner`, the lift is strict (the external task shape): a row that is not
|
|
535
|
+
* one of the three containers, or a container whose body is not an object, is
|
|
536
|
+
* refused. Without it, such rows are skipped, as the connector lift always did.
|
|
537
|
+
*/
|
|
538
|
+
function connectorInputs(slots, resolved, owner) {
|
|
539
|
+
const parameterByWireName = new Map();
|
|
540
|
+
for (const parameter of resolved.entry.operation?.parameters ?? [])
|
|
541
|
+
parameterByWireName.set(toCamel(String(parameter.name)), String(parameter.name));
|
|
542
|
+
const inputs = {};
|
|
543
|
+
for (const slot of slots) {
|
|
544
|
+
const name = String(slot?.name ?? '');
|
|
545
|
+
if (owner && !CONNECTOR_INPUT_CONTAINERS.has(name))
|
|
546
|
+
throw new Error(`${owner} has unsupported input row "${name}".`);
|
|
547
|
+
const body = slot?.body;
|
|
548
|
+
if (owner && body === undefined)
|
|
549
|
+
continue;
|
|
550
|
+
if (!body || typeof body !== 'object' || Array.isArray(body)) {
|
|
551
|
+
if (owner)
|
|
552
|
+
throw new Error(`${owner} input container "${name}" must carry an object body.`);
|
|
553
|
+
continue;
|
|
554
|
+
}
|
|
555
|
+
for (const [wireName, value] of Object.entries(body)) {
|
|
556
|
+
const authoredName = name === 'body' ? wireName : (parameterByWireName.get(wireName) ?? wireName);
|
|
557
|
+
inputs[authoredName] = value;
|
|
558
|
+
}
|
|
559
|
+
}
|
|
560
|
+
return inputs;
|
|
561
|
+
}
|
|
562
|
+
const CONNECTOR_INPUT_CONTAINERS = new Set(['pathParameters', 'queryParameters', 'body']);
|
|
525
563
|
function connectorCall(task, refs, library) {
|
|
526
564
|
if (!library)
|
|
527
565
|
throw new Error(`connector task "${task.displayName ?? task.id ?? '?'}" needs the connector library; pass DecompileOptions.library or --library.`);
|
|
@@ -541,19 +579,7 @@ function connectorCall(task, refs, library) {
|
|
|
541
579
|
version: connectorVersion(context),
|
|
542
580
|
});
|
|
543
581
|
const resolved = library.resolve(identity.key, identity.action, identity.version, identity.object);
|
|
544
|
-
const
|
|
545
|
-
for (const parameter of resolved.entry.operation?.parameters ?? [])
|
|
546
|
-
parameterByWireName.set(toCamel(String(parameter.name)), String(parameter.name));
|
|
547
|
-
const inputs = {};
|
|
548
|
-
for (const slot of Array.isArray(data.inputs) ? data.inputs : []) {
|
|
549
|
-
const body = slot?.body;
|
|
550
|
-
if (!body || typeof body !== 'object' || Array.isArray(body))
|
|
551
|
-
continue;
|
|
552
|
-
for (const [wireName, value] of Object.entries(body)) {
|
|
553
|
-
const authoredName = slot.name === 'body' ? wireName : (parameterByWireName.get(wireName) ?? wireName);
|
|
554
|
-
inputs[authoredName] = value;
|
|
555
|
-
}
|
|
556
|
-
}
|
|
582
|
+
const inputs = connectorInputs(Array.isArray(data.inputs) ? data.inputs : [], resolved);
|
|
557
583
|
const connection = bindingName(context.get('connection')?.value, refs);
|
|
558
584
|
const folder = bindingName(context.get('folderKey')?.value, refs);
|
|
559
585
|
const options = opts([
|
|
@@ -564,6 +590,14 @@ function connectorCall(task, refs, library) {
|
|
|
564
590
|
]);
|
|
565
591
|
return `.connector(${tsLiteral(identity.key)}, ${tsLiteral(identity.action)}, ${tsLiteral(inputs)}${options ? `, ${options}` : ''})`;
|
|
566
592
|
}
|
|
593
|
+
/**
|
|
594
|
+
* Lift an External Agent / External Workflow task saved in the Case Designer's
|
|
595
|
+
* shape (the one `serialize` emits): a connector activity's context and input
|
|
596
|
+
* containers plus the object's `executionType`, which becomes `mode`. The
|
|
597
|
+
* service type must be the one that execution type gives, so a plan whose two
|
|
598
|
+
* disagree is refused rather than lifted to a source that would compile to
|
|
599
|
+
* something else.
|
|
600
|
+
*/
|
|
567
601
|
function externalCall(task, refs, library) {
|
|
568
602
|
const kind = task.type;
|
|
569
603
|
const owner = `${kind} task "${task.displayName ?? task.id ?? '?'}"`;
|
|
@@ -574,33 +608,24 @@ function externalCall(task, refs, library) {
|
|
|
574
608
|
const unknownData = Object.keys(data).find((name) => !allowed.has(name));
|
|
575
609
|
if (unknownData)
|
|
576
610
|
throw new Error(`${owner} has unsupported data field "${unknownData}".`);
|
|
577
|
-
if (!Array.isArray(data.bindings) || data.bindings.length !== 0)
|
|
611
|
+
if (data.bindings !== undefined && (!Array.isArray(data.bindings) || data.bindings.length !== 0))
|
|
578
612
|
throw new Error(`${owner} data.bindings must be an empty array; bindings live at case root.`);
|
|
579
|
-
const modes = kind === 'external-agent'
|
|
580
|
-
? new Map([
|
|
581
|
-
[CASE_FORMAT_PROFILE.externalAgentSyncServiceType, 'sync'],
|
|
582
|
-
[CASE_FORMAT_PROFILE.externalAgentAsyncServiceType, 'async'],
|
|
583
|
-
])
|
|
584
|
-
: new Map([
|
|
585
|
-
[CASE_FORMAT_PROFILE.externalWorkflowSyncServiceType, 'sync'],
|
|
586
|
-
[CASE_FORMAT_PROFILE.externalWorkflowAsyncServiceType, 'async'],
|
|
587
|
-
]);
|
|
588
|
-
const mode = modes.get(data.serviceType);
|
|
589
|
-
if (!mode)
|
|
590
|
-
throw new Error(`${owner} has unsupported serviceType "${String(data.serviceType ?? '')}".`);
|
|
591
613
|
if (!Array.isArray(data.context))
|
|
592
614
|
throw new Error(`${owner} requires a resolved context array.`);
|
|
593
|
-
// A
|
|
594
|
-
//
|
|
595
|
-
|
|
596
|
-
|
|
597
|
-
|
|
598
|
-
|
|
599
|
-
|
|
600
|
-
const
|
|
601
|
-
if (
|
|
602
|
-
throw new Error(`${owner}
|
|
603
|
-
const
|
|
615
|
+
// A hybrid task carries an event pair the SDK cannot write back (#1387): refuse
|
|
616
|
+
// it by name, before its extra context rows are reported as unknown.
|
|
617
|
+
if (data.context.some((row) => row?.name === 'executionType' && row.value === 'hybrid'))
|
|
618
|
+
throw new Error(externalHybridRefusal(owner));
|
|
619
|
+
// Exactly the context rows serialize writes (the Designer's set): an unknown
|
|
620
|
+
// or repeated row would be dropped by the lift and lost on recompile.
|
|
621
|
+
const contextNames = data.context.map((row) => String(row?.name ?? ''));
|
|
622
|
+
const unknownContext = contextNames.find((name, at) => !EXTERNAL_TASK_CONTEXT.includes(name) || contextNames.indexOf(name) !== at);
|
|
623
|
+
if (unknownContext !== undefined)
|
|
624
|
+
throw new Error(`${owner} has unsupported or repeated context row "${unknownContext}".`);
|
|
625
|
+
const absentContext = EXTERNAL_TASK_CONTEXT.find((name) => !contextNames.includes(name));
|
|
626
|
+
if (absentContext)
|
|
627
|
+
throw new Error(`${owner} is missing context row "${absentContext}".`);
|
|
628
|
+
const context = contextMap(data);
|
|
604
629
|
const stringValue = (name) => {
|
|
605
630
|
const row = context.get(name);
|
|
606
631
|
if (row?.type !== 'string' || typeof row.value !== 'string' || !row.value)
|
|
@@ -616,36 +641,26 @@ function externalCall(task, refs, library) {
|
|
|
616
641
|
throw new Error(`${owner} context ${name} references missing root binding "${id}".`);
|
|
617
642
|
return bindingLabel(refs, id);
|
|
618
643
|
};
|
|
644
|
+
const mode = stringValue('executionType');
|
|
645
|
+
if (!isExternalExecutionMode(mode))
|
|
646
|
+
throw new Error(`${owner} has unsupported executionType "${mode}".`);
|
|
647
|
+
const serviceType = externalServiceType(kind, mode);
|
|
648
|
+
if (data.serviceType !== serviceType)
|
|
649
|
+
throw new Error(`${owner} has serviceType "${String(data.serviceType ?? '')}", but its executionType "${mode}" saves as "${serviceType}".`);
|
|
619
650
|
const identity = library.identifyAction({
|
|
620
651
|
connectorKey: stringValue('connectorKey'),
|
|
621
652
|
httpMethod: stringValue('method'),
|
|
622
653
|
endpoint: stringValue('path'),
|
|
654
|
+
objectName: stringValue('objectName'),
|
|
655
|
+
version: connectorVersion(context),
|
|
623
656
|
});
|
|
624
657
|
const resolved = library.resolve(identity.key, identity.action, identity.version, identity.object);
|
|
625
|
-
const
|
|
626
|
-
if (
|
|
627
|
-
throw new Error(`${owner}
|
|
628
|
-
if (stringValue('activity') !== resolved.activityTypeId)
|
|
629
|
-
throw new Error(`${owner} activity does not match its descriptor.`);
|
|
658
|
+
const refused = externalDescriptorRefusal(kind, resolved);
|
|
659
|
+
if (refused)
|
|
660
|
+
throw new Error(`${owner}: ${refused}`);
|
|
630
661
|
if (!Array.isArray(data.inputs))
|
|
631
662
|
throw new Error(`${owner} inputs must be an array.`);
|
|
632
|
-
const
|
|
633
|
-
const inputs = {};
|
|
634
|
-
for (const row of data.inputs) {
|
|
635
|
-
const name = String(row?.name ?? '');
|
|
636
|
-
if (!name || row.id !== name || row.target !== name || !fields.has(name))
|
|
637
|
-
throw new Error(`${owner} has unsupported input row "${name}".`);
|
|
638
|
-
inputs[name] = row.value;
|
|
639
|
-
}
|
|
640
|
-
const missing = resolved.fields.find((field) => field.required && !(field.name in inputs));
|
|
641
|
-
if (missing)
|
|
642
|
-
throw new Error(`${owner} is missing required input "${missing.name}".`);
|
|
643
|
-
if (!Array.isArray(data.outputs) || data.outputs.length !== 1)
|
|
644
|
-
throw new Error(`${owner} must carry exactly one response output.`);
|
|
645
|
-
const output = data.outputs[0];
|
|
646
|
-
if (output.name !== 'response' || output.type !== 'json' || output.source !== '.'
|
|
647
|
-
|| typeof output.var !== 'string' || output.id !== output.var)
|
|
648
|
-
throw new Error(`${owner} has an unsupported response output.`);
|
|
663
|
+
const inputs = connectorInputs(data.inputs, resolved, owner);
|
|
649
664
|
const descriptor = `{ nodeType: ${tsLiteral(resolved.nodeType)}, version: ${tsLiteral(resolved.version)} }`;
|
|
650
665
|
const options = opts([
|
|
651
666
|
['connection', tsLiteral(binding('connection'))],
|
package/dist/case/external.d.ts
CHANGED
|
@@ -8,6 +8,45 @@
|
|
|
8
8
|
* `buildConnectorInputs`, which `check` already runs as `connectorInputs`.
|
|
9
9
|
*/
|
|
10
10
|
import type { ResolvedConnector } from '../core/library.js';
|
|
11
|
+
import type { ExternalExecutionMode } from './case-sdk.js';
|
|
12
|
+
/**
|
|
13
|
+
* The context rows `serialize` writes on an external task: the set the Case
|
|
14
|
+
* Designer saves for a sync object (`uip`'s
|
|
15
|
+
* `tests/fixtures/external-tasks/designer-saved.json`, the Snowflake Cortex
|
|
16
|
+
* agent). `decompile` refuses a task with any other row, since the lift would
|
|
17
|
+
* drop it without a word. A `hybrid` task (which also carries `operation` and
|
|
18
|
+
* `eventMode`) is refused before this check; see {@link externalHybridRefusal}.
|
|
19
|
+
*/
|
|
20
|
+
export declare const EXTERNAL_TASK_CONTEXT: readonly string[];
|
|
21
|
+
/** Check's code for {@link externalHybridRefusal}. */
|
|
22
|
+
export declare const EXTERNAL_TASK_HYBRID_UNSUPPORTED = "EXTERNAL_TASK_HYBRID_UNSUPPORTED";
|
|
23
|
+
/**
|
|
24
|
+
* Why an external task on a `hybrid` object cannot be compiled or decompiled
|
|
25
|
+
* yet. The Case Designer saves such a task with an event pair (context
|
|
26
|
+
* `operation`, e.g. `TRIGGER_CREATED`, and `eventMode`, e.g. `polling`, also in
|
|
27
|
+
* the metadata's `activityPropertyConfiguration`) that it reads from live
|
|
28
|
+
* Integration Service metadata. The connector library does not carry that pair
|
|
29
|
+
* (#1387), so the SDK cannot write the task faithfully, and a guessed pair could
|
|
30
|
+
* deploy a task that never completes. `check`, `serialize` and `decompile` all
|
|
31
|
+
* refuse with this text.
|
|
32
|
+
*
|
|
33
|
+
* @param owner - The task as the message names it, e.g. `External Workflow task "Run"`.
|
|
34
|
+
* @returns The refusal.
|
|
35
|
+
*/
|
|
36
|
+
export declare function externalHybridRefusal(owner: string): string;
|
|
37
|
+
/** The execution types an external task accepts: the values Integration Service reports. */
|
|
38
|
+
export declare function isExternalExecutionMode(value: unknown): value is ExternalExecutionMode;
|
|
39
|
+
/**
|
|
40
|
+
* The `data.serviceType` the Case Designer saves for an external task of this
|
|
41
|
+
* execution type. Studio Web runs `hybrid` as `async` (`determineActualIntsvcType`),
|
|
42
|
+
* so both save as the `Async…Execution` type; the CLI's `externalServiceType`
|
|
43
|
+
* and its strict validator read the same table.
|
|
44
|
+
*
|
|
45
|
+
* @param kind - The task kind.
|
|
46
|
+
* @param mode - The connector object's `executionType`.
|
|
47
|
+
* @returns The service type.
|
|
48
|
+
*/
|
|
49
|
+
export declare function externalServiceType(kind: 'external-agent' | 'external-workflow', mode: ExternalExecutionMode): string;
|
|
11
50
|
/** Check's code for {@link externalDescriptorRefusal}. */
|
|
12
51
|
export declare const EXTERNAL_TASK_DESCRIPTOR_CONTRACT = "EXTERNAL_TASK_DESCRIPTOR_CONTRACT";
|
|
13
52
|
/**
|
|
@@ -17,8 +56,8 @@ export declare const EXTERNAL_TASK_DESCRIPTOR_CONTRACT = "EXTERNAL_TASK_DESCRIPT
|
|
|
17
56
|
* Workflow task a `ProcessExecution` one: the service type the task emits
|
|
18
57
|
* (`Intsvc.SyncAgentExecution`, …) is chosen by the family, and a descriptor of
|
|
19
58
|
* the other kind (or a plain connector action) would run the wrong contract.
|
|
20
|
-
* Both need the operation's `uiPathActivityTypeId`, which the task
|
|
21
|
-
*
|
|
59
|
+
* Both need the operation's `uiPathActivityTypeId`, which the task's `metadata`
|
|
60
|
+
* context carries.
|
|
22
61
|
*
|
|
23
62
|
* @param kind - The task kind.
|
|
24
63
|
* @param rc - What `library.resolve` returned for the task's descriptor.
|
package/dist/case/external.js
CHANGED
|
@@ -1,3 +1,57 @@
|
|
|
1
|
+
import { CASE_FORMAT_PROFILE } from './format-profile.js';
|
|
2
|
+
/**
|
|
3
|
+
* The context rows `serialize` writes on an external task: the set the Case
|
|
4
|
+
* Designer saves for a sync object (`uip`'s
|
|
5
|
+
* `tests/fixtures/external-tasks/designer-saved.json`, the Snowflake Cortex
|
|
6
|
+
* agent). `decompile` refuses a task with any other row, since the lift would
|
|
7
|
+
* drop it without a word. A `hybrid` task (which also carries `operation` and
|
|
8
|
+
* `eventMode`) is refused before this check; see {@link externalHybridRefusal}.
|
|
9
|
+
*/
|
|
10
|
+
export const EXTERNAL_TASK_CONTEXT = [
|
|
11
|
+
'connectorKey', 'connection', 'resourceKey', 'folderKey', 'objectName', 'method', 'path',
|
|
12
|
+
'executionType', 'metadata', 'activityConfigurationVersion',
|
|
13
|
+
];
|
|
14
|
+
/** Check's code for {@link externalHybridRefusal}. */
|
|
15
|
+
export const EXTERNAL_TASK_HYBRID_UNSUPPORTED = 'EXTERNAL_TASK_HYBRID_UNSUPPORTED';
|
|
16
|
+
/**
|
|
17
|
+
* Why an external task on a `hybrid` object cannot be compiled or decompiled
|
|
18
|
+
* yet. The Case Designer saves such a task with an event pair (context
|
|
19
|
+
* `operation`, e.g. `TRIGGER_CREATED`, and `eventMode`, e.g. `polling`, also in
|
|
20
|
+
* the metadata's `activityPropertyConfiguration`) that it reads from live
|
|
21
|
+
* Integration Service metadata. The connector library does not carry that pair
|
|
22
|
+
* (#1387), so the SDK cannot write the task faithfully, and a guessed pair could
|
|
23
|
+
* deploy a task that never completes. `check`, `serialize` and `decompile` all
|
|
24
|
+
* refuse with this text.
|
|
25
|
+
*
|
|
26
|
+
* @param owner - The task as the message names it, e.g. `External Workflow task "Run"`.
|
|
27
|
+
* @returns The refusal.
|
|
28
|
+
*/
|
|
29
|
+
export function externalHybridRefusal(owner) {
|
|
30
|
+
return (`${owner} is on a "hybrid" object, which Case cannot compile yet: the connector library does not carry ` +
|
|
31
|
+
`the event pair the Case Designer writes for it (operation, e.g. "TRIGGER_CREATED", and eventMode, e.g. "polling"), ` +
|
|
32
|
+
`so the task cannot be written faithfully. Add this task in Studio Web for now; ` +
|
|
33
|
+
`https://github.com/UiPath/builder-sdk/issues/1387 tracks the library change.`);
|
|
34
|
+
}
|
|
35
|
+
/** The execution types an external task accepts: the values Integration Service reports. */
|
|
36
|
+
export function isExternalExecutionMode(value) {
|
|
37
|
+
return value === 'sync' || value === 'async' || value === 'hybrid';
|
|
38
|
+
}
|
|
39
|
+
/**
|
|
40
|
+
* The `data.serviceType` the Case Designer saves for an external task of this
|
|
41
|
+
* execution type. Studio Web runs `hybrid` as `async` (`determineActualIntsvcType`),
|
|
42
|
+
* so both save as the `Async…Execution` type; the CLI's `externalServiceType`
|
|
43
|
+
* and its strict validator read the same table.
|
|
44
|
+
*
|
|
45
|
+
* @param kind - The task kind.
|
|
46
|
+
* @param mode - The connector object's `executionType`.
|
|
47
|
+
* @returns The service type.
|
|
48
|
+
*/
|
|
49
|
+
export function externalServiceType(kind, mode) {
|
|
50
|
+
const sync = mode === 'sync';
|
|
51
|
+
if (kind === 'external-agent')
|
|
52
|
+
return sync ? CASE_FORMAT_PROFILE.externalAgentSyncServiceType : CASE_FORMAT_PROFILE.externalAgentAsyncServiceType;
|
|
53
|
+
return sync ? CASE_FORMAT_PROFILE.externalWorkflowSyncServiceType : CASE_FORMAT_PROFILE.externalWorkflowAsyncServiceType;
|
|
54
|
+
}
|
|
1
55
|
/** Check's code for {@link externalDescriptorRefusal}. */
|
|
2
56
|
export const EXTERNAL_TASK_DESCRIPTOR_CONTRACT = 'EXTERNAL_TASK_DESCRIPTOR_CONTRACT';
|
|
3
57
|
/**
|
|
@@ -7,8 +61,8 @@ export const EXTERNAL_TASK_DESCRIPTOR_CONTRACT = 'EXTERNAL_TASK_DESCRIPTOR_CONTR
|
|
|
7
61
|
* Workflow task a `ProcessExecution` one: the service type the task emits
|
|
8
62
|
* (`Intsvc.SyncAgentExecution`, …) is chosen by the family, and a descriptor of
|
|
9
63
|
* the other kind (or a plain connector action) would run the wrong contract.
|
|
10
|
-
* Both need the operation's `uiPathActivityTypeId`, which the task
|
|
11
|
-
*
|
|
64
|
+
* Both need the operation's `uiPathActivityTypeId`, which the task's `metadata`
|
|
65
|
+
* context carries.
|
|
12
66
|
*
|
|
13
67
|
* @param kind - The task kind.
|
|
14
68
|
* @param rc - What `library.resolve` returned for the task's descriptor.
|