@uipath/maestro-builder-sdk 6.21.1 → 6.21.2

package/dist/case/compile-cli.js

@@ -7,11 +7,14 @@
  *
  * Runs the fast static check first; if it passes, serializes to a V30
  * caseplan.json. The authoritative deploy gate is `uip maestro case validate`.
- * Output defaults to `caseplan.json` (the platform's canonical file name).
+ * Output defaults to the plan file the project in the working directory ships
+ * (`caseplan.case` for a project `uip maestro case init` scaffolded), else
+ * `caseplan.json`. An `-o` that names a different plan file than the project
+ * ships is refused (CASE_OUTPUT_NOT_SHIPPED).
  */
 import { reportDiagnostics, reportResult, thrownDiagnostic } from '../cli-result.js';
 import { writeJsonFile } from '../core/json-file.js';
-import { readFileSync, existsSync } from 'node:fs';
+import { readFileSync, existsSync, readdirSync } from 'node:fs';
 import { join, dirname, basename, resolve } from 'node:path';
 import { resolveCaseFile, loadBuiltCase } from './load.js';
 import { serialize } from './serialize.js';
@@ -28,7 +31,7 @@ import { sha256Uuid } from '../core/stable-id.js';
 import { isRecord } from '../core/node-envelope.js';
 export async function run(argv) {
     if (argv.length === 0 || argv[0] === '-h' || argv[0] === '--help') {
-        console.error('usage: compile <case.ts | BaseName> [-o caseplan.json]');
+        console.error('usage: compile <case.ts | BaseName> [-o <project>/caseplan.case]');
         return 2;
     }
     const flags = new Set(['-o', '--library', '--bindings', '--connectors-local']);
@@ -61,6 +64,14 @@ export async function run(argv) {
         console.error(`compile: ${errors.length} error(s); not emitting.`);
         return 1;
     }
+    const out = flagValue(argv, '-o') ?? shippedCasePlanName('.') ?? 'caseplan.json';
+    const shadow = shadowedOutputDiagnostic(out);
+    if (shadow) {
+        console.error(`  ✗ [${shadow.code}] ${shadow.message}`);
+        reportDiagnostics([...diags, shadow]);
+        console.error('compile: 1 error(s); not emitting.');
+        return 1;
+    }
     let caseplan;
     try {
         caseplan = serialize(built, { library, bindings });
@@ -69,7 +80,6 @@ export async function run(argv) {
         reportDiagnostics([...diags, thrownDiagnostic(error)]);
         throw error;
     }
-    const out = flagValue(argv, '-o') ?? 'caseplan.json';
     writeJsonFile(out, caseplan);
     const stages = caseplan.nodes.filter((n) => String(n.type).endsWith('Stage')).length;
     const triggers = syncEntryPoints(caseplan, out);
@@ -80,6 +90,70 @@ export async function run(argv) {
     reportResult({ path: resolve(out), stages, ...(triggers >= 0 ? { triggers } : {}), ...(resources >= 0 ? { resources } : {}) });
     return 0;
 }
+/**
+ * The file names a Case project's plan can have, in the order the packager
+ * (`@uipath/packager-tool-case` `CasePlanFileNames`) picks the first one present.
+ * `uip maestro case init` scaffolds `caseplan.case` since uipath-cli#5004.
+ */
+const CASE_PLAN_FILE_NAMES = ['caseplan.case', 'caseplan.json', 'case.stage.json', 'default.stage.json'];
+/**
+ * The plan file the project in `dir` ships, or undefined when `dir` is not a
+ * Case project. Decided as the packager decides: the first plan file present in
+ * packager order. The packager regenerates `package-descriptor.json` from that
+ * file (Studio Web renames the plan without updating the descriptor), so the
+ * descriptor is only a fallback when no plan file exists yet.
+ */
+function shippedCasePlanName(dir) {
+    // Exact directory entries, as the packager matches them: `existsSync` ignores
+    // case on macOS and Windows, so `CasePlan.case` would pass for `caseplan.case`.
+    let entries;
+    try {
+        entries = new Set(readdirSync(dir));
+    }
+    catch {
+        entries = new Set();
+    }
+    return CASE_PLAN_FILE_NAMES.find((name) => entries.has(name)) ?? describedCaseFileName(dir);
+}
+/**
+ * Refuse to write a plan file the package will not ship: pack, debug and deploy
+ * would read the other plan. Non-plan names (`<Name>.caseplan.json`) are not
+ * checked.
+ */
+function shadowedOutputDiagnostic(outPath) {
+    const name = basename(outPath);
+    // Case-insensitive: on macOS and Windows `-o CasePlan.json` writes over caseplan.json.
+    if (!CASE_PLAN_FILE_NAMES.includes(name.toLowerCase()))
+        return undefined;
+    const dir = dirname(outPath);
+    const shipped = shippedCasePlanName(dir);
+    if (!shipped || shipped === name)
+        return undefined;
+    const target = join(dir, shipped);
+    return {
+        level: 'error',
+        code: 'CASE_OUTPUT_NOT_SHIPPED',
+        message: `the project ships ${target}, not ${outPath}; writing ${name} beside it leaves the shipped plan unchanged, ` +
+            `so pack, debug and deploy would use the old ${shipped}.`,
+        suggestion: `compile with -o ${target}`,
+    };
+}
+/** The case file `package-descriptor.json` in `dir` ships, if it names one. */
+function describedCaseFileName(dir) {
+    const descriptorPath = join(dir, 'package-descriptor.json');
+    if (!existsSync(descriptorPath))
+        return undefined;
+    try {
+        const files = JSON.parse(readFileSync(descriptorPath, 'utf8'))?.files;
+        if (files && typeof files === 'object') {
+            // The descriptor keys the pair by logical name; the case file is the one
+            // whose BPMN sibling it also ships.
+            return Object.keys(files).find((k) => `${k}.bpmn` in files);
+        }
+    }
+    catch { /* a malformed descriptor is not worth failing a compile over */ }
+    return undefined;
+}
 /**
  * The name of the case file THE PACKAGE SHIPS, which is what an entry point's
  * `filePath` has to name — not the name this compile happened to write.
@@ -92,30 +166,12 @@ export async function run(argv) {
  * task that took that path never left `Pending (0/0 elements completed)`: the
  * debug instance was created and no element ever started.
  *
- * `package-descriptor.json` is the project's own declaration of what it ships
- * and `uip maestro case init` writes it beside `entry-points.json`, so it is the
- * authority whenever it is there.
+ * The packaged pair is decided by `shippedCasePlanName` (the plan file on disk,
+ * in packager order, else the descriptor); only when neither exists does the
+ * output's own name stand.
  */
 function packagedCaseFileName(dir, outPath) {
-    const descriptorPath = join(dir, 'package-descriptor.json');
-    if (existsSync(descriptorPath)) {
-        try {
-            const files = JSON.parse(readFileSync(descriptorPath, 'utf8'))?.files;
-            if (files && typeof files === 'object') {
-                // The descriptor keys the pair by logical name; the case file is the one
-                // whose BPMN sibling it also ships.
-                const named = Object.keys(files).find((k) => `${k}.bpmn` in files);
-                if (named)
-                    return named;
-            }
-        }
-        catch { /* a malformed descriptor is not worth failing a compile over */ }
-    }
-    // No descriptor (a project scaffolded some other way): a sibling `caseplan.json`
-    // still says what the project ships, and only the output name is in doubt.
-    if (existsSync(join(dir, 'caseplan.json')))
-        return 'caseplan.json';
-    return basename(outPath);
+    return shippedCasePlanName(dir) ?? basename(outPath);
 }
 /**
  * Keep the sibling `entry-points.json` in step with the caseplan's trigger nodes:

package/package.json

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