@uipath/maestro-builder-sdk 6.36.0 → 6.37.0

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.0",
+  "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": "6eb5a3b4536c8fe021771e7dd0ad44c76dd30cfe"
+  "gitref": "e7e986c269c7f0f0b561327523501319eb350cdd"
 }