@uipath/packager-tool-case 1.201.0-preview.133 → 1.202.0-preview.134

package/dist/case-bpmn-compiler.d.ts

@@ -0,0 +1,25 @@
+/**
+ * Registry for the `caseplan.json` -> BPMN compiler.
+ *
+ * The compiler lives in `@uipath/case-schema`, a 2.5 MB CommonJS bundle that
+ * `require`s `child_process`, `tls` and `http2`. This package builds for the
+ * browser (StudioWeb loads it as a micro-frontend), so it cannot import that
+ * dependency directly. Instead it declares the interface and whoever runs on
+ * Node registers the real thing — `@uipath/packager-tool-case/node` provides
+ * that implementation, and the CLI tools that register the Case factory call
+ * it alongside.
+ *
+ * Nothing registered means no compile: `CaseTool` then requires the project to
+ * carry an already-compiled `.bpmn` and fails the build with an actionable
+ * message if it does not. It never packs a case silently missing its BPMN.
+ */
+/** Compiles the contents of `caseplan.json` into BPMN XML. */
+export type CaseBpmnCompiler = (casePlanJson: string) => Promise<string>;
+/**
+ * Register the compiler used by `CaseTool.buildAsync`. Last call wins. Pass
+ * `undefined` to clear it — how a test reproduces a host that never
+ * registered one.
+ */
+export declare function registerCaseBpmnCompiler(caseBpmnCompiler: CaseBpmnCompiler | undefined): void;
+/** The registered compiler, or `undefined` when none was registered. */
+export declare function getCaseBpmnCompiler(): CaseBpmnCompiler | undefined;

package/dist/case-tool.d.ts

@@ -3,9 +3,11 @@ import { type IFileSystem, type IToolLogger, ProjectTool, ToolResult } from "@ui
 /**
  * Case Management project tool implementation.
  *
- * Case Management projects use .stage.json source files that are converted
- * to .bpmn format. All files are placed in the content/ folder (no separate
- * source folder like flow_files/).
+ * The authored source is `caseplan.json`; the runtime reads the BPMN compiled
+ * from it. `entry-points.json` points at `/content/caseplan.json.bpmn`, so the
+ * build compiles that file into content/ — a package without it deploys and
+ * activates fine and then faults every job it starts (UV-15809). All files are
+ * placed in the content/ folder (no separate source folder like flow_files/).
  */
 export declare class CaseTool extends ProjectTool {
     private readonly _temporaryStorage;
@@ -20,6 +22,47 @@ export declare class CaseTool extends ProjectTool {
      * Case Management projects keep all files in content/ (no separate folder).
      */
     private copyFiles;
+    /**
+     * Compile `caseplan.json` into `content/caseplan.json.bpmn`.
+     *
+     * Runs after copyFiles on purpose: a stale `caseplan.json.bpmn` left in the
+     * project directory by an earlier `uip maestro case pack` is copied in
+     * first and then overwritten here, so an edited case plan can never ship
+     * against an old BPMN. Nothing is written back into the project directory —
+     * packing a solution does not mutate the user's source tree.
+     *
+     * The compiler is injected (see `case-bpmn-compiler.ts`). With none
+     * registered — a browser host, where `@uipath/case-schema` cannot run — the
+     * project has to bring its own compiled `.bpmn`.
+     */
+    private compileCasePlan;
+    /**
+     * Verify every `.bpmn` `entry-points.json` names is actually in content/.
+     *
+     * This is the defect UV-15809 reported, checked mechanically: the entry
+     * point resolved to a file the package did not contain, so it deployed and
+     * activated cleanly and then faulted every job. Checking the declaration
+     * rather than a fixed filename covers both project shapes — a CLI project
+     * (`caseplan.json` -> `caseplan.json.bpmn`) and a Studio Web one
+     * (`<name>.stage.json` shipped with its compiled `<name>.stage.json.bpmn`)
+     * — and a stray `.bpmn` left behind by `uip case debug` cannot stand in for
+     * the one that is missing.
+     *
+     * No `entry-points.json` means nothing declares an entry point, so there is
+     * nothing to resolve and nothing to fail on.
+     */
+    private checkEntryPointBpmnPresent;
+    /**
+     * The `.bpmn` file names `entry-points.json` refers to. Entries look like
+     * `/content/caseplan.json.bpmn#<triggerId>`; `uip case debug` writes them
+     * without the `content/` prefix, so both forms are accepted.
+     *
+     * No file at all means nothing is declared, so the caller has nothing to
+     * check. A file that is there but cannot be read as JSON returns `null`:
+     * treating that as "nothing declared" would wave through the very package
+     * this check exists to stop, since the entry point it names is unknown.
+     */
+    private readEntryPointBpmnFiles;
     /**
      * Create operate.json file if it doesn't already exist
      */