@uipath/maestro-builder-sdk 6.36.1 → 6.37.0

package/dist/registry/prepare/messages.js

@@ -23,6 +23,7 @@
 import { Refusal, messageOf } from "../errors.js";
 import { commentText } from "../../core/comment-text.js";
 import { plausibleMatches } from "./actions.js";
+import { HTTP_METHOD_TO_OPERATION } from "../library-build/enrich.js";
 import { pyGet, pyOr, pyRepr, pyStrAny, pyTruthy } from "./support.js";
 export const PREFIX = "prepare-connector: ";
 /** The spelling the Python hard-coded into every pasteable re-run. */
@@ -178,7 +179,7 @@ function sharedTokens(wanted, candidate) {
  * offline validators accept and the runtime dispatches to the wrong operation.
  */
 export function unresolvedOperationMessage(input) {
-    const { connectorKey: key, name, probes, catalog } = input;
+    const { connectorKey: key, name, probes, catalog, integrationService, registryRefresh } = input;
     const lines = [
         `${PREFIX}\`${key} ${name}\` is neither an action nor an event the registry serves:`,
         ...probeLines(probes),
@@ -221,6 +222,8 @@ export function unresolvedOperationMessage(input) {
     else {
         lines.push("", `\`registry search ${key}\` lists no action for ${key} either.`);
     }
+    if (integrationService !== undefined)
+        lines.push("", ...integrationServiceLines(key, name, integrationService, registryRefresh));
     lines.push("", "`registry get` and `registry search` answer from the CLI's local copy of the catalog.", "If it looks stale, refresh it first: `uip maestro flow registry pull --force`.", 
     // Named `flow` on purpose, whatever family you are authoring: this is the
     // catalog `prepare` itself reads, and `uip maestro bpmn registry pull` fills
@@ -311,6 +314,84 @@ export function tsNote(jsonOnly, connectorKey) {
 export function preparedSummaryLine(nodeType, out, ts, variants, fieldNote) {
     return `${PREFIX}${nodeType} → ${out}/ (${ts}, ${variants} variant(s), ${fieldNote})`;
 }
+/**
+ * "The catalog serves no node for <key>", worded by what was measured: a fact
+ * after a forced pull, the local copy's answer when the pull failed or did not
+ * run (`registry get` and `registry search` answer from a copy that never
+ * refreshes itself).
+ */
+export function catalogServesNothingPhrase(key, refresh) {
+    if (refresh?.ok === true)
+        return `the Flow node catalog, refreshed with \`uip maestro flow registry pull --force\`, serves no node for ${key}`;
+    const why = refresh === undefined ? "it was not refreshed" : `refreshing it failed: ${refresh.reason}`;
+    return `the CLI's local copy of the Flow node catalog serves no node for ${key} (${why})`;
+}
+/** The progress line before the one `registry pull --force` the fallback runs. */
+export function refreshingCatalogLine(key) {
+    return `  the local catalog copy serves no node for ${key}; refreshing it (uip maestro flow registry pull --force) and looking again.`;
+}
+/** The warning when that pull failed; the fallback continues against the local copy. */
+export function catalogRefreshFailedLine(reason) {
+    return `${PREFIX}registry pull --force failed (${reason}); continuing with the local catalog copy, which may be stale.`;
+}
+/** The note when the author's `--action` spelling was not the entry's id. */
+export function actionCanonicalizedLine(given, actionId) {
+    return `  action: "${given}" is Integration Service activity ${actionId}; the entry is written under that id.`;
+}
+/**
+ * What Integration Service serves when the Flow catalog serves nothing for a
+ * connector: the curated activities' action ids, so the author re-runs with
+ * one of them, or why the one they named could not be read.
+ */
+export function integrationServiceLines(key, name, miss, refresh) {
+    const phrase = catalogServesNothingPhrase(key, refresh);
+    const head = `${phrase[0].toUpperCase()}${phrase.slice(1)}, so Integration Service was asked instead (\`uip is activities list ${key}\`).`;
+    if (miss.kind === "no-catalog") {
+        return miss.reason === undefined
+            ? [head, `It lists no curated activity for ${key} either — the connector may need enabling on this tenant, or the key may be misspelt.`]
+            : [head, `That call failed: ${miss.reason}`, "Fix that (the connection, the login, the connector's enablement on this tenant), then re-run."];
+    }
+    if (miss.kind === "no-operation") {
+        return [
+            head,
+            `It lists \`${name}\` (${miss.activity.name}: ${miss.activity.objectName} ${miss.activity.method}), but ${miss.activity.method} maps to no`,
+            `\`is resources\` operation (${[...HTTP_METHOD_TO_OPERATION.keys()].join(", ")} do), so there is no describe to prepare it from.`,
+            "Author it as an `.activity('Intsvc.ActivityExecution')` task from `uip is activities list` and `uip is resources describe` by hand.",
+        ];
+    }
+    if (miss.kind === "no-schema") {
+        return [
+            head,
+            `It lists \`${name}\` (${miss.activity.name}: ${miss.activity.objectName} ${miss.activity.method}), but`,
+            `\`uip is resources describe ${key} ${miss.activity.objectName} --operation ${miss.operation} --connection-id <id>\` returned no schema for it,`,
+            "so there is nothing to prepare from. Check the connection, then re-run.",
+        ];
+    }
+    const close = plausibleMatches(name, miss.activities);
+    const lines = [head];
+    if (close.length > 0)
+        lines.push(`Closest activity to "${name}": ${close.slice(0, 3).join(", ")}`);
+    lines.push(`Activities Integration Service serves for ${key} (re-run with one as --action):`, ...miss.activities.map((a) => `  ${a}`));
+    return lines;
+}
+/** The action path's source line when Integration Service supplied the entry. */
+export function preparedFromIntegrationServiceLine(key, activity, refresh) {
+    return (`  source: Integration Service activity ${activity.name} (${activity.objectName} ${activity.method}) — ${catalogServesNothingPhrase(key, refresh)}, `
+        + "so this operation compiles in BPMN only (a Flow step or agent tool needs the registry's node definition).");
+}
+/**
+ * The pasteable BPMN call for an operation prepared from Integration Service —
+ * the only family that compiles it, so the Flow import handoff is not printed
+ * for it. Required inputs are named with their type; the rest are left to the
+ * descriptor the overlay carries.
+ */
+export function bpmnConnectorUsageLines(connectorKey, action, required, boundConnection = "<binding-name>", boundFolder = "<folder-binding-name>") {
+    const inputs = required.map((f) => `${/^[A-Za-z_$][A-Za-z0-9_$]*$/.test(f.name) ? f.name : JSON.stringify(f.name)}: /* ${commentText(f.type)}, required */`).join(", ");
+    return [
+        `.connector("<id>", "${connectorKey}", "${action}", { ${inputs} }, { connection: "${boundConnection}", folder: "${boundFolder}" })`,
+        "this operation was prepared from Integration Service, so it compiles in BPMN only; `bpmn check` and `bpmn compile` read the overlay from ./connectors-local (or --connectors-local <dir>).",
+    ];
+}
 /** Why this run did not overwrite the overlay (`_keep_prepared_schema`). */
 export function keptSchemaMessage(action, kept, discarded) {
     return (`${PREFIX}kept the prepared schema for ${action} ` +

package/dist/registry/prepare/pipeline.js

@@ -35,12 +35,13 @@ import { enrichEntry } from "../library-build/enrich.js";
 import { expandGenericForConnector, genericTemplatesByOp } from "../library-build/generic-expand.js";
 import { planLibrary } from "../library-build/plan.js";
 import { MemoryResponseCache } from "../uip/response-cache.js";
-import { registryCatalog } from "./actions.js";
+import { refreshRegistryCatalog, registryCatalog } from "./actions.js";
 import { chooseConnection, listConnections, lookupConnection, mergeBindings, restoreBindings, snapshotBindings, solutionConnectionIds, } from "./connections.js";
 import { prepareEvent } from "./event.js";
+import { integrationServiceEntry } from "./integration-service.js";
 import { descriptorUsage } from "./handoff.js";
 import { ResolutionsExhausted, allParentsResolved, resolvedParentValues, writeResolutions } from "./ledger.js";
-import { PREPARE_COMMAND, PrepareRefusal, ambiguousLabelsMessage, connectionChoiceLine, bindingsLine, candidateLabel, connectionLine, generatedModulesLine, genericActionNeedsObjectMessage, inputFieldNote, flagDiffersFromSourceLine, keptSchemaMessage, labelTakenMessage, lookupVocabularyLines, missingGenericSchemaMessage, missingParentsNote, nextLine, noCanonicalEntryMessage, objectFlagsOnlyForGenericMessage, objectNoteLine, objectRecordedLine, parentFieldNamesMismatchMessage, parentOnlyMessage, prefixed, preparedSummaryLine, rejectedParentFieldsMessage, rerunAgainstLine, resolvedParentsNote, registryGetFailedMessage, sharedLabelMessage, sourceLabelSuffix, tsNote, partlyUnreadableLabelLine, unreadableLabelLine, unresolvedOperationMessage, } from "./messages.js";
+import { PREPARE_COMMAND, PrepareRefusal, ambiguousLabelsMessage, connectionChoiceLine, bindingsLine, bpmnConnectorUsageLines, candidateLabel, connectionLine, generatedModulesLine, genericActionNeedsObjectMessage, inputFieldNote, flagDiffersFromSourceLine, keptSchemaMessage, labelTakenMessage, lookupVocabularyLines, missingGenericSchemaMessage, missingParentsNote, nextLine, noCanonicalEntryMessage, objectFlagsOnlyForGenericMessage, objectNoteLine, objectRecordedLine, parentFieldNamesMismatchMessage, parentOnlyMessage, prefixed, preparedFromIntegrationServiceLine, actionCanonicalizedLine, catalogRefreshFailedLine, refreshingCatalogLine, preparedSummaryLine, rejectedParentFieldsMessage, rerunAgainstLine, resolvedParentsNote, registryGetFailedMessage, sharedLabelMessage, sourceLabelSuffix, tsNote, partlyUnreadableLabelLine, unreadableLabelLine, unresolvedOperationMessage, } from "./messages.js";
 import { ObjectMatchRefusal, RESOLUTIONS_FILENAME, matchObject, recordObjectResolution } from "./objects.js";
 import { countInputFields, keepPreparedSchema, lookupSpecsFromOverlay, mergeFilesInto, parentFields as overlayParentFields, schemaActionParents, } from "./overlay.js";
 import { declaredParents, objectActionRequest, objectActionSpecs, parseFields } from "./parents.js";
@@ -326,13 +327,21 @@ export async function prepareConnector(options, ports) {
         return prepareConnector({ ...options, ...labels, connectionId: chosenId, refreshLookups: true }, ports);
     }
 }
-/** Everything after stage 0, against one settled connection. */
-async function prepareOnConnection(options, ports, connected) {
+/**
+ * Everything after stage 0, against one settled connection. `registryRefresh`
+ * is set on the one re-entry after `registry pull --force` (below), so the
+ * pull runs at most once per command.
+ */
+async function prepareOnConnection(options, ports, connected, registryRefresh) {
     const cwd = ports.cwd ?? process.cwd();
     const info = (line) => ports.reporter.info(line);
     const warn = (line) => ports.reporter.warn(line);
     const command = ports.prepareCommand ?? PREPARE_COMMAND;
-    const { connectorKey, action } = options;
+    const { connectorKey } = options;
+    // Rebound to the activity's own action id when Integration Service supplies
+    // the entry, so the overlay path, the summary and the handoff all spell the
+    // id the entry goes by rather than the author's `--action`.
+    let action = options.action;
     const fieldPairs = options.fields ?? [];
     const parentFields = parseFields(fieldPairs);
     const outShown = options.out ?? defaultOverlayOut(cwd);
@@ -341,7 +350,8 @@ async function prepareOnConnection(options, ports, connected) {
     const jsonOnly = options.jsonOnly ?? false;
     const { connectionId, bound, rollback } = connected;
     const ctx = createBuildContext({ client: ports.client, caches: ports.caches ?? memoryCaches(), reporter: ports.reporter, concurrency: 1, timeoutMs: ports.timeoutMs }, { connectionId, parentFields });
-    const nodeType = `uipath.connector.${connectorKey}.${action}`;
+    let nodeType = `uipath.connector.${connectorKey}.${action}`;
+    let fromIntegrationService;
     const actionProbe = await registryProbe(ctx, nodeType);
     if ("miss" in actionProbe) {
         // Not an activity. Connector EVENTS live one namespace over, and their
@@ -375,20 +385,52 @@ async function prepareOnConnection(options, ports, connected) {
             throw new PrepareRefusal(registryGetFailedMessage(connectorKey, action, probes), "REGISTRY_GET_FAILED");
         }
         const catalog = await registryCatalog(ports.client, connectorKey, ports.timeoutMs);
-        throw new PrepareRefusal(unresolvedOperationMessage({ connectorKey, name: action, probes, catalog }), "OPERATION_UNKNOWN");
+        // A catalog that serves NOTHING for the connector — no action, no event, and
+        // the search itself answered — is a connector the Flow registry does not
+        // carry, not a misspelt action on one it does. Integration Service still
+        // serves it, and a BPMN connector task needs nothing more.
+        if (catalog.failure === undefined && catalog.actions.length === 0 && catalog.events.length === 0) {
+            // The probes and the search answer from the CLI's local catalog copy,
+            // which never refreshes itself. Pull once and look again before
+            // concluding anything: a stale copy would send a connector the catalog
+            // does serve down the BPMN-only path, and the summary would state it.
+            if (registryRefresh === undefined) {
+                info(refreshingCatalogLine(connectorKey));
+                const refreshed = await refreshRegistryCatalog(ports.client, ports.timeoutMs);
+                if (!refreshed.ok)
+                    warn(catalogRefreshFailedLine(refreshed.reason));
+                return prepareOnConnection(options, ports, connected, refreshed);
+            }
+            const prepared = await integrationServiceEntry(ctx, { connectorKey, action });
+            if ("miss" in prepared) {
+                throw new PrepareRefusal(unresolvedOperationMessage({ connectorKey, name: action, probes, catalog, integrationService: prepared.miss, registryRefresh }), "OPERATION_UNKNOWN");
+            }
+            info(preparedFromIntegrationServiceLine(connectorKey, prepared.activity, registryRefresh));
+            if (prepared.action !== action)
+                info(actionCanonicalizedLine(action, prepared.action));
+            action = prepared.action;
+            nodeType = prepared.entry.nodeType;
+            fromIntegrationService = prepared;
+        }
+        else {
+            throw new PrepareRefusal(unresolvedOperationMessage({ connectorKey, name: action, probes, catalog }), "OPERATION_UNKNOWN");
+        }
     }
-    const payload = ctx.caches.registry.read(actionProbe.name);
+    // The registry reply this entry came from, or none when Integration Service
+    // supplied it — then there is no node to read parents from and the sidecar
+    // is built from the synthesized node instead.
+    const payload = fromIntegrationService === undefined && "name" in actionProbe ? ctx.caches.registry.read(actionProbe.name) : undefined;
     // The registry's own declaration of parent inputs, read from the same reply.
-    const declared = declaredParents(payload);
-    let entry = extractCanonical(nodeOf(payload));
+    const declared = payload === undefined ? [] : declaredParents(payload);
+    let entry = fromIntegrationService?.entry ?? extractCanonical(nodeOf(payload));
     if (entry === undefined)
         throw new PrepareRefusal(noCanonicalEntryMessage(nodeType), "NO_CANONICAL_ENTRY");
     if (options.version)
         entry.version = options.version;
     if (parentFields.size > 0) {
-        const request = objectActionRequest(payload, parentFields);
+        const request = payload === undefined ? undefined : objectActionRequest(payload, parentFields);
         if (request === undefined) {
-            throw new PrepareRefusal(parentFieldNamesMismatchMessage([...parentFields.keys()], objectActionSpecs(payload)), "PARENT_FIELDS_MISMATCH");
+            throw new PrepareRefusal(parentFieldNamesMismatchMessage([...parentFields.keys()], payload === undefined ? [] : objectActionSpecs(payload)), "PARENT_FIELDS_MISMATCH");
         }
         entry.operation.customFieldsRequestDetails = request;
     }
@@ -422,11 +464,14 @@ async function prepareOnConnection(options, ports, connected) {
     else {
         if (objectName || options.allObjects)
             throw new PrepareRefusal(objectFlagsOnlyForGenericMessage(), "OBJECT_NOT_GENERIC");
-        entry = await enrichEntry(ctx, entry); // full schema via --connection-id
+        // An Integration Service entry IS the describe; there is nothing to enrich it with.
+        if (fromIntegrationService === undefined)
+            entry = await enrichEntry(ctx, entry); // full schema via --connection-id
         preparedEntries = [entry];
     }
     const entryNodeType = entry.nodeType;
-    const plan = planLibrary(preparedEntries, (requestedNodeType) => (requestedNodeType === entryNodeType ? nodeOf(payload) : undefined));
+    const sidecarNode = fromIntegrationService?.node ?? nodeOf(payload);
+    const plan = planLibrary(preparedEntries, (requestedNodeType) => (requestedNodeType === entryNodeType ? sidecarNode : undefined));
     for (const line of plan.warnings)
         warn(line);
     const kept = keepPreparedSchema(out, entryNodeType, plan.files, parentFields, objectName);
@@ -501,7 +546,20 @@ async function prepareOnConnection(options, ports, connected) {
             warn(missingParentsNote(connectorKey, action, actionParents, missing, parentFields, command));
         }
     }
-    if (!jsonOnly) {
+    if (fromIntegrationService !== undefined) {
+        // BPMN is the family that compiles this entry, so the handoff is its call,
+        // whether or not a module was generated; the Flow import is never repointed.
+        const required = fromIntegrationService.entry.inputSchema?.fields ?? [];
+        const params = fromIntegrationService.entry.operation.parameters ?? [];
+        const fields = [
+            ...params.filter((f) => f.required === true).map((f) => ({ name: String(f.name), type: String(f.dataType ?? "string") })),
+            ...required.filter((f) => f.required === true).map((f) => ({ name: String(f.name), type: String(f.type ?? f.dataType ?? "string") })),
+        ];
+        for (const line of bpmnConnectorUsageLines(connectorKey, action, fields, pyOr(bound?.connection, "<binding-name>"), pyOr(bound?.folder, "<folder-binding-name>"))) {
+            info(nextLine(line));
+        }
+    }
+    else if (!jsonOnly) {
         // Print what was bound, so the last line of output is a call the reader
         // can paste rather than `<binding-name>` placeholders. `or`, not `??`: an
         // empty symbolic name is a placeholder in Python's eyes too.

package/dist/registry/uip/commands.d.ts

@@ -17,7 +17,15 @@ export declare function connectionArgs(connectionId?: string): string[];
 export declare function fieldArgs(parentFields: ReadonlyMap<string, string> | Readonly<Record<string, string>> | undefined): string[];
 export declare function registrySearchConnectors(): string[];
 export declare function registrySearch(query: string): string[];
+/**
+ * `uip maestro flow registry pull --force`: refresh the CLI's local copy of the
+ * Flow node catalog, which `registry get` and `registry search` answer from and
+ * which never refreshes itself.
+ */
+export declare function registryPull(): string[];
 export declare function registryGet(nodeType: string, connectionId?: string): string[];
+/** `uip is activities list <key> --output json`: the connector's activity catalog — curated activities with their object and HTTP method, and the generic record verbs. No connection needed. */
+export declare function isActivitiesList(connectorKey: string): string[];
 export declare function isConnectorsMetadata(connectorKey: string): string[];
 export declare function isResourcesDescribeOperation(connectorKey: string, objectName: string, operation: string, connectionId?: string, parentFields?: ReadonlyMap<string, string> | Readonly<Record<string, string>>): string[];
 export declare function isResourcesDescribeObject(connectorKey: string, objectName: string, connectionId?: string): string[];

package/dist/registry/uip/commands.js

@@ -28,9 +28,21 @@ export function registrySearchConnectors() {
 export function registrySearch(query) {
     return [UIP, "maestro", "flow", "registry", "search", query, "--output", "json"];
 }
+/**
+ * `uip maestro flow registry pull --force`: refresh the CLI's local copy of the
+ * Flow node catalog, which `registry get` and `registry search` answer from and
+ * which never refreshes itself.
+ */
+export function registryPull() {
+    return [UIP, "maestro", "flow", "registry", "pull", "--force"];
+}
 export function registryGet(nodeType, connectionId) {
     return [UIP, "maestro", "flow", "registry", "get", nodeType, "--output", "json", ...connectionArgs(connectionId)];
 }
+/** `uip is activities list <key> --output json`: the connector's activity catalog — curated activities with their object and HTTP method, and the generic record verbs. No connection needed. */
+export function isActivitiesList(connectorKey) {
+    return [UIP, "is", "activities", "list", connectorKey, "--output", "json"];
+}
 export function isConnectorsMetadata(connectorKey) {
     return [UIP, "is", "connectors", "metadata", connectorKey, "--output", "json"];
 }

package/dist/serialize.js

@@ -22,6 +22,7 @@ import { resolveVersionCarried } from './core/nodes/versioned.js';
 import { indexCarriedDefinitions } from './core/carried-definitions.js';
 import { formFieldJsonSchema, formFieldSettingsWire, wireFormFieldType } from './core/form-field-type.js';
 import { ConnectorResolveError } from './core/connector-resolve-error.js';
+import { synthesizedDefinitionRefusal } from './core/synthesized-definition.js';
 import { connectionConnectors } from './bindings-v2.js';
 import { BindingRefusal, GUID_RE, bindingLabelRefusal, bindingMissingMessage, missingBindingLabels } from './core/binding-messages.js';
 import { ByoaRefusal, byoaUnverified } from './core/byoa.js';
@@ -5225,6 +5226,10 @@ export function serialize(built, opts = {}) {
                     addEdge(scope, t, id);
                 return [{ node: id, port: successPort(type) }];
             }
+            // An entry `prepare` synthesized from Integration Service compiles in BPMN only.
+            const noDefinition = synthesizedDefinitionRefusal(rc);
+            if (noDefinition)
+                throw noDefinition;
             const id = stepUid(scope, step.name);
             const node = makeNode(rc.nodeType, id, step.name, { parentId, requestedVersion: step.options?.version, def: rc.v1def });
             declareListOutputType(node, rc);
@@ -5594,6 +5599,12 @@ export function serialize(built, opts = {}) {
                     if (!opts.library)
                         throw new Error(`inline agent "${step.name}"'s connector tool needs a library (pass --library / set $FLOW_SDK_LIBRARY_JSON).`);
                     const rc = opts.library.resolve(tr.connector, tr.operation, tr.version, tr.object);
+                    // An entry `prepare` synthesized from Integration Service compiles in
+                    // BPMN only — for a tool as for a step: `connectorToolDef` reads the
+                    // same definition, and a synthesized one has no form or handles.
+                    const noDefinition = synthesizedDefinitionRefusal(rc);
+                    if (noDefinition)
+                        throw noDefinition;
                     tdef = connectorToolDef(rc);
                     label = tr.name ?? rc.v1def?.display?.label ?? tr.operation;
                     // The connection rides the same three places it does for a

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@uipath/maestro-builder-sdk",
-  "version": "6.36.1",
+  "version": "6.37.0",
   "description": "Build UiPath Flow, Case, and BPMN artifacts by writing TypeScript.",
   "license": "MIT",
   "homepage": "https://docs.uipath.com/maestro",
@@ -93,5 +93,5 @@
     "@types/node": "^22.7.0",
     "esbuild": "^0.28.1"
   },
-  "gitref": "ede4fb3b6b1911bfc170114e086299b28a413d71"
+  "gitref": "e7e986c269c7f0f0b561327523501319eb350cdd"
 }