@uipath/maestro-builder-sdk 6.9.4 → 6.10.0

package/dist/registry/generators/markdown/sections/schema-dynamic.js

@@ -54,14 +54,14 @@ export function schemaDynamicLines(j, nodeType) {
     out.push("> ```bash");
     // ONE spelling on every page, the one `check` prints; no `--connection-id`.
     if (discovery) {
-        out.push(`> npx flow-sdk registry prepare ${key} ${action} ${supply}`);
+        out.push(`> npx flow-sdk registry prepare ${key} --action ${action} ${supply}`);
     }
     else if (supply) {
-        out.push(`> npx flow-sdk registry prepare ${key} ${action} \\`);
+        out.push(`> npx flow-sdk registry prepare ${key} --action ${action} \\`);
         out.push(`>   ${supply}`);
     }
     else {
-        out.push(`> npx flow-sdk registry prepare ${key} ${action}`);
+        out.push(`> npx flow-sdk registry prepare ${key} --action ${action}`);
     }
     out.push("> ```");
     out.push(">");

package/dist/registry/library-build/cli.js

@@ -13,6 +13,8 @@
  * tenant, which is the only way its exit codes can be pinned.
  */
 import { rmSync } from "node:fs";
+import { resolve } from "node:path";
+import { reportResult } from "../../cli-result.js";
 import { UsageError, exitCodeOf, messageOf } from "../errors.js";
 import { consoleReporter } from "../reporter.js";
 import { OfflineUipClient, defaultUipClient } from "../uip/client.js";
@@ -173,6 +175,7 @@ export async function run(argv, deps = {}) {
             }
         }
         reporter.info("Done!");
+        reportResult({ outputDir: resolve(options.outputDir) });
         return 0;
     }
     catch (error) {

package/dist/registry/materialize-cli.js

@@ -1,3 +1,5 @@
+import { resolve } from "node:path";
+import { reportResult } from "../cli-result.js";
 import { exitCodeOf, messageOf } from "./errors.js";
 import { materializeRegistry } from "./materializer.js";
 /**
@@ -51,6 +53,11 @@ export async function run(argv) {
             checkSymbols: argv.includes("--check-symbols"),
             checkOrphans: argv.includes("--check-orphans"),
         });
+        reportResult({
+            libraryJson: resolve(libraryJsonPath),
+            ...(libraryMarkdownPath ? { libraryMarkdown: resolve(libraryMarkdownPath) } : {}),
+            ...(connectorsPath ? { connectors: resolve(connectorsPath) } : {}),
+        });
         return 0;
     }
     catch (error) {

package/dist/registry/path-cli.js

@@ -1,3 +1,4 @@
+import { reportResult } from '../cli-result.js';
 import { join } from "node:path";
 import { CURRENT_LINK, currentEntrySha, libraryCacheRoot, resolveCachedLibrary, resolveCachedMarkdown, } from "./cache.js";
 /**
@@ -27,7 +28,11 @@ export async function run(argv) {
     const libraryJson = resolveCachedLibrary();
     const libraryMarkdown = resolveCachedMarkdown();
     const sha256 = currentEntrySha();
-    const single = (value) => {
+    // With one flag, `--json` reports just that field, like the text output. A
+    // caller capturing one value (`uip maestro registry path --sha --output
+    // plain`, which prints each Data value) must still get exactly one.
+    const single = (field, value) => {
+        reportResult({ [field]: value ?? null });
         if (!value) {
             console.error("No connector library in the cache yet. Run `flow-sdk registry pull`.");
             return 1;
@@ -36,20 +41,22 @@ export async function run(argv) {
         return 0;
     };
     if (argv.includes("--library-json"))
-        return single(libraryJson);
+        return single("libraryJson", libraryJson);
     if (argv.includes("--library-md"))
-        return single(libraryMarkdown);
+        return single("libraryMarkdown", libraryMarkdown);
     if (argv.includes("--root"))
-        return single(root);
+        return single("root", root);
     if (argv.includes("--sha"))
-        return single(sha256);
-    console.log(JSON.stringify({
+        return single("sha256", sha256);
+    const all = {
         root,
         current: join(root, CURRENT_LINK),
         sha256: sha256 ?? null,
         libraryJson: libraryJson ?? null,
         libraryMarkdown: libraryMarkdown ?? null,
-    }, null, 2));
+    };
+    reportResult(all);
+    console.log(JSON.stringify(all, null, 2));
     // Not an error: a caller asking for the whole picture is entitled to be told
     // the cache is empty, rather than getting a non-zero exit for a plain report.
     return 0;

package/dist/registry/prepare/messages.js

@@ -73,7 +73,7 @@ export function sourceLabelSuffix(files) {
 export function ambiguousLabelsMessage(attribute, connectorKey, action, labels, command) {
     const flag = attribute === "connection" ? "--bind-connection" : "--bind-folder";
     const files = [...new Set([...labels.values()].flat())];
-    const lines = [...labels.keys()].map((label) => `  ${command} ${connectorKey} ${action} ${flag} ${label} --connection-id <id>`);
+    const lines = [...labels.keys()].map((label) => `  ${command} ${connectorKey} --action ${action} ${flag} ${label} --connection-id <id>`);
     return prefixed(`${files.join(", ")} ${files.length === 1 ? "uses" : "use"} ${labels.size} ${attribute} labels for ${connectorKey} `
         + `(${[...labels.keys()].join(", ")}), and one prepare binds one ${attribute === "connection" ? "connection" : "folder key"}. `
         + `Bind each label to the connection it means, one run per label:\n${lines.join("\n")}\n`
@@ -328,7 +328,7 @@ export function resolvedParentsNote(connectorKey, action, actionParents, resolve
     return (`${PREFIX}note: this operation resolves its fields ` +
         "from the VALUES of parent inputs, and the resolutions above " +
         "ARE those values. Re-run to materialize the full field set:\n" +
-        `  ${command} ${connectorKey} ${action} ${fieldsArg}`);
+        `  ${command} ${connectorKey} --action ${action} ${fieldsArg}`);
 }
 /** The note when some schema parent did not arrive as `-f`, with the example re-run. */
 export function missingParentsNote(connectorKey, action, actionParents, missing, parentFields, command = PREPARE_COMMAND) {
@@ -347,7 +347,7 @@ export function missingParentsNote(connectorKey, action, actionParents, missing,
         "body field the object declares is not there yet and compile " +
         "will refuse it as an unknown input. Re-run passing ALL of them " +
         "as -f NAME=VALUE (a partial set is rejected):\n" +
-        `  ${command} ${connectorKey} ${action} ${example}`);
+        `  ${command} ${connectorKey} --action ${action} ${example}`);
 }
 /**
  * `_print_lookup_vocabulary`: the lookup table for the operation just
@@ -374,7 +374,7 @@ export function lookupVocabularyLines(connectorKey, action, objectName, specs, c
     const [field, spec] = shown[0];
     const by = (pyTruthy(spec.by) ? spec.by : ["id"])[0];
     const obj = objectName ? ` --object ${objectName}` : "";
-    lines.push(`${PREFIX}resolve with: ${command} ${connectorKey} ${action}${obj} --resolve ${field}:${by}=<value>`);
+    lines.push(`${PREFIX}resolve with: ${command} ${connectorKey} --action ${action}${obj} --resolve ${field}:${by}=<value>`);
     return lines;
 }
 // ---------------------------------------------------------------------------

package/dist/registry/prepare/pipeline.d.ts

@@ -50,6 +50,8 @@ export interface PreparePorts {
     /** How the pasteable `registry prepare` is spelled in the notes. */
     prepareCommand?: string;
 }
+/** Where prepare writes its overlay when `--out` is not given. */
+export declare const DEFAULT_OVERLAY_DIR = "./connectors-local";
 export interface PrepareReport {
     kind: "action" | "event";
     /** The node type the overlay entry is stored under (the WAIT form for an event). */

package/dist/registry/prepare/pipeline.js

@@ -49,6 +49,8 @@ import { retryOtherConnections } from "./retry.js";
 import { repointSource } from "./source-import.js";
 import { sourceBindingLabels } from "./source-labels.js";
 import { isPlainObject, pyGet, pyOr, pyPathJoin, pyPathlibStr, pyStrAny, pyTruthy } from "./support.js";
+/** Where prepare writes its overlay when `--out` is not given. */
+export const DEFAULT_OVERLAY_DIR = "./connectors-local";
 function memoryCaches() {
     return { registry: new MemoryResponseCache(), is: new MemoryResponseCache(), connectors: new MemoryResponseCache() };
 }
@@ -105,7 +107,7 @@ function chooseLabels(options, ports) {
     const command = ports.prepareCommand ?? PREPARE_COMMAND;
     const labels = sourceBindingLabels({
         cwd: ports.cwd ?? process.cwd(),
-        out: options.out ?? "./connectors-local",
+        out: options.out ?? DEFAULT_OVERLAY_DIR,
         connectorKey: options.connectorKey,
         source: options.source,
     });
@@ -308,7 +310,7 @@ async function prepareOnConnection(options, ports, connected) {
     const { connectorKey, action } = options;
     const fieldPairs = options.fields ?? [];
     const parentFields = parseFields(fieldPairs);
-    const outShown = options.out ?? "./connectors-local";
+    const outShown = options.out ?? DEFAULT_OVERLAY_DIR;
     const out = resolve(cwd, outShown);
     const importSpecifier = options.importSpecifier ?? PACKAGE_NAME;
     const jsonOnly = options.jsonOnly ?? false;

package/dist/registry/prepare-cli.js

@@ -1,7 +1,9 @@
+import { resolve } from 'node:path';
+import { reportResult } from '../cli-result.js';
 import { PACKAGE_NAME } from "../package-name.js";
 import { exitCodeOf } from "./errors.js";
 import { exitText } from "./prepare/messages.js";
-import { prepareConnector as runPipeline } from "./prepare/pipeline.js";
+import { DEFAULT_OVERLAY_DIR, prepareConnector as runPipeline } from "./prepare/pipeline.js";
 import { consoleReporter } from "./reporter.js";
 import { defaultUipClient } from "./uip/client.js";
 // This mirrors the generator's own flags one for one, so a `--version` here is
@@ -12,7 +14,7 @@ import { defaultUipClient } from "./uip/client.js";
  * relative path that only resolves inside a source checkout. */
 const DEFAULT_CONNECTOR_IMPORT = PACKAGE_NAME;
 const USAGE = [
-    "Usage: flow-sdk registry prepare <connector-key> <action> [--connection-id <id>]",
+    "Usage: flow-sdk registry prepare <connector-key> --action <name> [--connection-id <id>]",
     "                                [--connection <name>] [--bindings <file>] [--no-bindings]",
     "                                [--object <name> | --all-objects] [-f NAME=VALUE ...]",
     "                                [--resolve FIELD:BY=VALUE ...] [--refresh-lookups]",
@@ -180,7 +182,8 @@ export async function run(argv) {
         }
     }
     try {
-        await prepareConnector(options);
+        const report = await prepareConnector(options);
+        reportResult({ connector: options.connectorKey, action: options.action, overlay: resolve(options.outPath ?? DEFAULT_OVERLAY_DIR), ...report });
         return 0;
     }
     catch (error) {

package/dist/registry/pull-cli.js

@@ -1,6 +1,7 @@
+import { reportResult } from '../cli-result.js';
 import { createHash } from "node:crypto";
 import { mkdir, readFile, rename, rm, stat, symlink, writeFile, } from "node:fs/promises";
-import { join } from "node:path";
+import { join, resolve } from "node:path";
 import { CURRENT_LINK, LIBRARY_JSON_DIR, LIBRARY_MARKDOWN_DIR, cacheEntry, libraryCacheRoot, referencedConnectorKeys, } from "./cache.js";
 import { extractLibrary } from "./extractor.js";
 import { materializeRegistry } from "./materializer.js";
@@ -302,6 +303,14 @@ export async function run(argv) {
         if (!value(argv, "--library")) {
             await pointCurrentAt(cacheDir, sha256);
         }
+        reportResult({
+            sha256,
+            library: resolve(libraryPath),
+            libraryMarkdown: resolve(markdownPath),
+            madeCurrent: !value(argv, "--library"),
+            connectors: resolve(connectorsPath),
+            generated: referenced,
+        });
         console.error(`registry pull: ${sha256.slice(0, 12)}… ready in ${cacheDir}` +
             (value(argv, "--library") ? "" : ` (current -> ${sha256.slice(0, 12)}…)`));
         if (referenced.length > 0) {

package/dist/registry/search-cli.js

@@ -1,3 +1,4 @@
+import { reportResult } from '../cli-result.js';
 import { readFile, stat } from "node:fs/promises";
 import { resolveLibraryDir } from "./cache.js";
 import { dirname, join } from "node:path";
@@ -149,6 +150,7 @@ export async function run(argv) {
             connector: value(argv, "--connector"),
             limit,
         });
+        reportResult(result);
         console.log(JSON.stringify(result, null, 2));
         return 0;
     }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@uipath/maestro-builder-sdk",
-  "version": "6.9.4",
+  "version": "6.10.0",
   "description": "Build UiPath Flow, Case, and BPMN artifacts by writing TypeScript.",
   "license": "MIT",
   "homepage": "https://docs.uipath.com/maestro",
@@ -55,6 +55,11 @@
     "bpmn-merge": "./dist/bpmn/merge-cli.js",
     "flow-registry-materialize": "./dist/registry/materialize-bin.js"
   },
+  "cliCapabilities": [
+    "merge-original-option",
+    "prepare-action-option",
+    "json-result"
+  ],
   "files": [
     "dist",
     "lib/library-json.samples",
@@ -87,5 +92,5 @@
     "@types/node": "^22.7.0",
     "esbuild": "^0.28.1"
   },
-  "gitref": "ca9f8350a07eaf7ec145b315ad37e75e00a23049"
+  "gitref": "d50db2eeec64253d691dc9512ee9e7027062665b"
 }