@uipath/flow-tool 1.204.0 → 1.205.0-preview.258

package/dist/services/flow-debug-service.d.ts

@@ -1,320 +0,0 @@
-/**
- * Service for debugging Flow files.
- *
- * Converts a .flow file to BPMN XML, generates the required project files,
- * begins a debug session in Orchestrator, creates a debug instance in PIMS,
- * and polls for execution status.
- */
-import type { Workflow } from "@uipath/flow-core";
-import type { BeginSessionResponse, DebugCallbacks, DebugInstanceResponse, DebugInstanceStatusResponse, DebugResult, DebugVariablesResponse, ElementExecution, StudioWebDebugConfig } from "@uipath/maestro-sdk";
-import { DebugProvisioningFailedError } from "@uipath/maestro-sdk/debug-service";
-import { RuntimeProfile } from "@uipath/packager-tool-flow";
-import { type SolutionImportResponse } from "@uipath/solution-sdk";
-export type { BeginSessionResponse, DebugCallbacks, DebugInstanceResponse, DebugInstanceStatusResponse, DebugResult, DebugVariablesResponse, ElementExecution, SolutionImportResponse, StudioWebDebugConfig, };
-/**
- * Canonical user-facing message + instructions surfaced when `flow debug`
- * is run against a standalone Flow project (no enclosing `.uipx`).
- *
- * Exported so the command layer (and tests) can assert the exact envelope
- * shape required by UiPath/cli#2023 without re-stringifying it.
- */
-export declare const FLOW_DEBUG_MISSING_SOLUTION_MESSAGE = "Flow debug requires this Flow to be inside a solution.";
-export declare const FLOW_DEBUG_MISSING_SOLUTION_INSTRUCTIONS = "Create a solution wrapper and import this Flow before debugging: `uip solution init <name>` then `uip solution projects import <flow-dir>` from inside the solution directory, then re-run `uip maestro flow debug`.";
-/**
- * Canonical user-facing message surfaced when the Flow project's directory
- * is not listed in the enclosing solution's `.uipx` Projects[] manifest.
- *
- * Without this preflight, Studio Web rejects the upload with an opaque
- *   `Import failed (400): The solution archive does not contain any valid projects.`
- * (MST-10004). Failing locally with the project path + solution path is
- * far more actionable.
- */
-export declare const FLOW_DEBUG_UNREGISTERED_PROJECT_MESSAGE = "Flow project is not registered in the enclosing solution.";
-export declare const buildFlowDebugUnregisteredProjectInstructions: (projectDir: string, solutionFile: string) => string;
-/**
- * Thrown by {@link FlowDebugService.executeProjectViaStudioWeb} when the
- * Flow project is not enclosed by a `.uipx` solution wrapper.
- *
- * The command layer translates this into a `ValidationError` envelope
- * (exit code 3) so users get an actionable, locally-generated diagnostic
- * before any upload is attempted — fixing the opaque server-side 400
- * tracked in UiPath/cli#2023.
- */
-export declare class MissingSolutionWrapperError extends Error {
-    readonly instructions: string;
-    constructor(message?: string, instructions?: string);
-}
-/**
- * Thrown by {@link FlowDebugService.executeProjectViaStudioWeb} when an
- * enclosing `.uipx` solution wrapper exists but does not list the Flow
- * project directory in its `Projects[]` manifest.
- *
- * The command layer translates this into a `ValidationError` envelope
- * (exit code 3). This replaces the opaque server-side
- *   `Import failed (400): The solution archive does not contain any valid projects.`
- * surfaced from Studio Web (MST-10004) with a typed, locally-detected
- * diagnostic that names the exact repair command.
- */
-export declare class UnregisteredProjectError extends Error {
-    readonly instructions: string;
-    readonly projectDir: string;
-    readonly solutionFile: string;
-    constructor(projectDir: string, solutionFile: string);
-}
-/**
- * Pick the refresh warnings that say a bound resource does not exist and
- * reduce each to the resource it names.
- *
- * The refresh result only carries warnings as strings, so this matches the
- * two anchored "not found" shapes above. The `Link it before deploy: ...`
- * tail is dropped — it is deploy-time advice with a literal `<file>`
- * placeholder, and the debug envelope's `Instructions` already say what to
- * do. Duplicates are removed, since several bindings can point at the same
- * resource.
- */
-export declare function selectMissingResourceWarnings(warnings: readonly string[]): string[];
-export declare function buildFlowDebugMissingResourcesInstructions(missingResources: readonly string[]): string;
-/**
- * Studio Web rejected the debug resources (`validationFailed`) and the
- * pre-upload refresh had already reported bound resources it could not find.
- * Keeps the original provisioning message as the prefix and appends those
- * warnings, since Studio Web's own error names neither node nor resource.
- */
-export declare class DebugProvisioningMissingResourcesError extends DebugProvisioningFailedError {
-    readonly instructions: string;
-    readonly missingResources: readonly string[];
-    constructor(cause: DebugProvisioningFailedError, missingResources: readonly string[]);
-}
-/**
- * Add the refresh's not-found warnings to a `validationFailed` provisioning
- * error. Any other error, or no such warnings, comes back unchanged.
- */
-export declare function withMissingResourceContext(error: Error, missingResourceWarnings: readonly string[]): Error;
-/**
- * What an upload-only run returns: the solution is on Studio Web and the
- * designer URL is known, but no debug session or instance was created.
- */
-export interface StudioWebUploadResult {
-    uploadedOnly: true;
-    solutionId: string;
-    studioWebUrl: string;
-}
-export declare const FLOW_DEBUG_INBOUND_VOICE_MESSAGE = "Inbound voice flows cannot be debugged from the CLI.";
-export declare const buildFlowDebugInboundVoiceInstructions: (triggerLabel: string) => string;
-/**
- * Thrown when the flow starts from an incoming-call trigger. Only a real call
- * to a published flow can raise one, so the run would never advance.
- */
-export declare class InboundVoiceDebugError extends Error {
-    readonly instructions: string;
-    constructor(triggerLabel: string);
-}
-/**
- * Reject a flow that starts from an incoming-call trigger. Keyed on the
- * trigger, not on voice nodes: an outbound flow carries the same nodes.
- */
-export declare function assertNotInboundVoiceFlow(workflow: {
-    nodes?: readonly unknown[];
-}): void;
-export declare class FlowDebugService {
-    private readonly fs;
-    constructor();
-    /**
-     * Pre-flight check: confirm the Flow project lives inside a `.uipx`
-     * solution wrapper by walking ancestor directories.
-     *
-     * Throws {@link MissingSolutionWrapperError} if no `.uipx` is found.
-     * Reuses {@link findNearestParentUipxFile} from `@uipath/solution-sdk`
-     * to share the ancestor-walk semantics with `uip solution projects import`.
-     *
-     * Returns the absolute path of the `.uipx` file when present so callers
-     * can log it without re-walking.
-     */
-    assertEnclosingSolution(projectPath: string): Promise<string>;
-    /**
-     * Pre-flight check: confirm the Flow project's directory is actually
-     * listed in the enclosing solution's `.uipx` `Projects[]` manifest.
-     *
-     * Throws {@link UnregisteredProjectError} when the manifest does not
-     * include the project. Comparison is canonicalized via `realpath()`
-     * so case-insensitive filesystems and symlinks don't yield false
-     * negatives.
-     *
-     * This is the local guard for MST-10004: without it, Studio Web
-     * silently accepts the upload and then rejects the import with an
-     * opaque `code:20001 / "The solution archive does not contain any
-     * valid projects."` HTTP 400. By failing locally, the agent (or
-     * human) gets the exact repair command (`uip solution projects add`)
-     * before any network I/O.
-     */
-    assertProjectRegisteredInSolution(projectPath: string, solutionFile: string): Promise<void>;
-    /**
-     * Read and parse a .flow file.
-     */
-    readFlowFile(flowFilePath: string): Promise<Workflow>;
-    /**
-     * Read a .bpmn file and return the raw XML string.
-     */
-    readBpmnFile(bpmnFilePath: string): Promise<string>;
-    /**
-     * Convert a Workflow to BPMN XML using @uipath/flow-converter.
-     *
-     * The inline-agent `Orchestrator.StartInlineAgentJob` activity's
-     * `entryPoint` must stay BARE (`<projectId>/agent.json`, no `content/`
-     * prefix). At debug time Orchestrator's debug-flow detector resolves the
-     * agent by matching the activity `entryPoint` against the
-     * `FpsProperties.debug.master.processes[].entryPointPath` entry, and that
-     * entry uses the bare path. A `content/`-prefixed activity entryPoint never
-     * matches, so the agent faults with `[170007]` "the job's associated
-     * process could not be found" (verified byte-for-byte against a working
-     * Studio Web debug capture, which also emits the bare path).
-     *
-     * We therefore do NOT call `setPublishIntentOnInlineAgents` here — that
-     * marks agents `__packageIntent = "Publish"`, which makes the converter
-     * emit the `content/`-prefixed form used by real publish/deploy. That form
-     * is wrong for a debug session.
-     */
-    convertToBpmn(workflow: Workflow, projectDir?: string): Promise<string>;
-    /**
-     * Reconstruct inline-agent `agentInputVariables` from each agent's
-     * `agent.json` `inputSchema` when the flow node leaves them empty.
-     *
-     * Studio Web keeps the input binding in the agent's `inputSchema` and rebuilds
-     * the node's `agentInputVariables` from it on load; the `.flow` it writes
-     * carries an empty `agentInputVariables`. The CLI converter derives the
-     * agent's `JobArguments` from `agentInputVariables` (it never reads
-     * `agent.json`), so an SW-authored flow would otherwise convert to an agent
-     * with empty input — works in SW, fails on `uip maestro flow debug`.
-     *
-     * We mirror SW: for each inline-agent node, read `<projectDir>/<source>/agent.json`
-     * and **reconcile** the node's `agentInputVariables` against the agent's
-     * `inputSchema.properties` — the contract the runtime actually binds. We
-     * *add* a derived entry for every schema input LEAF the node is missing and
-     * *preserve* every entry the node already declares, so a custom/divergent
-     * binding is never clobbered. Leaves are enumerated encoding-agnostically
-     * (MST-12020): a flat key (`<node>__output__<field>`) is one leaf; a NESTED
-     * schema's `x-uipath-container` trees are descended to their leaves — so an
-     * agent.json authored by a nested-flag canvas still reconciles per-field
-     * bindings instead of one un-navigable whole-container binding. Either way
-     * the derived id is the FLAT spelling (matching the packager's flat-healed
-     * prompt tokens), the binding is `=$vars.<node>.output.<field>`
-     * (`metadata`-rooted paths → `$metadata`), and "already declares" is
-     * checked on the CANONICAL dotted path so a flat and a nested spelling of
-     * the same input never produce a duplicate JobArgument.
-     *
-     * Reconciling (rather than only filling an empty list) also catches drift: an
-     * `agent.json` that gained an input the `.flow` node never re-wired would
-     * otherwise silently drop that input at debug. We therefore always read the
-     * agent.json. Best-effort — a missing/unreadable `agent.json` or absent
-     * `inputSchema` leaves the node as-is, and a node that already covers every
-     * schema key is left untouched (no spurious mutation).
-     */
-    private hydrateInlineAgentInputs;
-    /**
-     * Generate project files (operate.json, entry-points.json, bindings_v2.json,
-     * package-descriptor.json) into a temporary directory alongside the BPMN and .flow file.
-     */
-    generateProjectFiles(flowData: Workflow, bpmnXml: string, flowFileContent?: string, startEventId?: string, profile?: RuntimeProfile): Promise<string>;
-    /**
-     * Build a .uis solution package from the generated project files.
-     * Creates a solution wrapper, zips it into .uis format.
-     */
-    buildSolutionPackage(projectDir: string, projectName: string): Promise<string>;
-    private writeSingleProjectSolutionMetadata;
-    /**
-     * Build the `debug.master.processes` descriptors for every in-solution
-     * project so a flow-as-node callee's `Orchestrator.StartAgenticProcess`
-     * resolves the child — the same FpsProperties registry inline agents use,
-     * so no Orchestrator provisioning or deployed release is needed.
-     *
-     * Each descriptor pairs the Studio Web-minted `projectId` (from the upload
-     * result, matched by folder name) and the uploaded `solutionId` with the
-     * project's type + per-project entry point read from the staged solution.
-     * The lead Flow being debugged gets the exact BPMN + start node the session
-     * launches from; standalone Agent projects are skipped (inline agents are
-     * registered separately via `inlineAgents`).
-     */
-    private buildSolutionProjectDescriptors;
-    /**
-     * Compile a sibling flow project's `.flow` to BPMN + packaging artifacts
-     * in place inside its staged directory. Sibling flow projects are copied
-     * from the solution with only their `.flow` source; a flow-as-node call
-     * needs the compiled `.bpmn` (and bindings/manifests) in the package or the
-     * child job faults with 180003 (FileMissingInProjectArchive). Mirrors the
-     * artifact generation the lead flow already gets.
-     */
-    private generateSiblingFlowPackage;
-    /**
-     * Write a flow project's debug-package artifacts (`.flow`, compiled
-     * `.bpmn`, packaging manifests, resolved flow) into `projectDir`. Shared by
-     * the lead flow being debugged and each sibling flow-as-node callee so the
-     * conversion/packaging pipeline lives in one place. Returns the values the
-     * lead path needs downstream (entry points, start node, bpmn file name).
-     */
-    private writeFlowProjectPackage;
-    /** Map a raw `.uiproj` ProjectType to the BeginSession wire vocabulary. */
-    private toWireProjectType;
-    /**
-     * Normalize an entry point to the `debug.master` form: no leading slash,
-     * no `content/` prefix (e.g. `/Flow.bpmn#start` or
-     * `content/new.bpmn#manualTrigger1` → `Flow.bpmn#start` / `new.bpmn#manualTrigger1`).
-     */
-    private normalizeEntryPoint;
-    /** Read the first `entry-points.json` filePath in a project dir, or "". */
-    private readFirstEntryPointPath;
-    /**
-     * Derive an entry point from a project's compiled `.bpmn` start event,
-     * for projects whose `entry-points.json` is empty (ProcessOrchestration).
-     * Matches Studio Web's `/{bpmn}#{startEvent}` form (leading slash kept).
-     * Returns "" when no `.bpmn` is present.
-     */
-    private deriveEntryPointFromBpmn;
-    /** Read a project's `.uiproj` `ProjectType`, or undefined if unavailable. */
-    private readProjectTypeRaw;
-    /**
-     * Build a name→type map from the `.uipx` Projects array so
-     * {@link buildSolutionProjectDescriptors} can resolve the type for
-     * projects that have no `project.uiproj` (JS/TS Functions).
-     */
-    static buildProjectTypeMap(projects?: Array<{
-        ProjectRelativePath: string;
-        Type?: unknown;
-    }>): Map<string, string>;
-    /**
-     * Full Studio Web debug flow from a flow project directory:
-     * 1. Validate project directory has required files
-     * 2. Read .flow file + generate packaging artifacts on the fly
-     * 3. Build .uis solution package containing ALL projects in the solution
-     * 5. Upload/overwrite to Studio Web → get projectId + solutionId
-     * 6. Begin debug session in Orchestrator → get jobKey
-     * 7. Create debug instance in PIMS with solutionId + projectId
-     * 8. Poll PIMS debug-instances for completion
-     */
-    executeProjectViaStudioWeb(projectPath: string, config: StudioWebDebugConfig, callbacks?: DebugCallbacks, pollInterval?: number, options?: {
-        inputs?: Record<string, unknown>;
-        maxPolls?: number;
-        /**
-         * Upload the solution and stop. For a flow only a chat UI can drive,
-         * a debug instance would sit unused — and its message subscription
-         * would block the next run — so the CLI hands the user the designer
-         * URL instead of starting a session nobody can advance.
-         */
-        uploadOnly?: boolean;
-    }): Promise<DebugResult | StudioWebUploadResult>;
-    /**
-     * Full Studio Web debug flow:
-     * 1. Read .flow/.bpmn file
-     * 2. Convert to BPMN (if .flow)
-     * 3. Generate project files
-     * 4. Build .uis solution package
-     * 5. Upload to Studio Web → get projectId + solutionId
-     * 6. Begin debug session in Orchestrator → get jobKey
-     * 7. Create debug instance in PIMS with solutionId + projectId
-     * 8. Poll PIMS debug-instances for completion
-     */
-    executeViaStudioWeb(filePath: string, config: StudioWebDebugConfig, callbacks?: DebugCallbacks, pollInterval?: number, options?: {
-        inputs?: Record<string, unknown>;
-        keep?: boolean;
-        maxPolls?: number;
-    }): Promise<DebugResult>;
-}

package/dist/services/flow-eval-schema/deterministic-evaluators.d.ts

@@ -1,110 +0,0 @@
-export declare const DETERMINISTIC_EVALUATOR_TYPES: {
-    readonly "uipath-contains": {
-        readonly name: "Contains Text";
-        readonly description: "Check if output contains specific text";
-        readonly category: "deterministic";
-        readonly shortDescription: "Passes when output contains given text";
-        readonly configFields: readonly [{
-            readonly key: "targetOutputKey";
-            readonly label: "Target Output Key";
-            readonly type: "targetOutputKey";
-            readonly required: false;
-            readonly description: "The key in the output to evaluate";
-        }, {
-            readonly key: "caseSensitive";
-            readonly label: "Case Sensitive";
-            readonly type: "boolean";
-            readonly required: false;
-            readonly default: false;
-            readonly description: "If true, the comparison is case-sensitive";
-        }, {
-            readonly key: "negated";
-            readonly type: "boolean";
-            readonly required: false;
-            readonly default: false;
-            readonly description: "If true, the evaluation passes when the match is not found";
-            readonly label: "Negated (should NOT contain)";
-        }];
-        readonly criteriaFields: readonly [{
-            readonly key: "searchText";
-            readonly label: "Search Text";
-            readonly type: "string";
-            readonly required: false;
-            readonly minLength: 1;
-            readonly description: "The text to search for in the output";
-        }];
-        readonly examples: {
-            readonly criteria: {
-                readonly searchText: "loan approved";
-            };
-        };
-    };
-    readonly "uipath-exact-match": {
-        readonly name: "Exact Match";
-        readonly description: "Check if output exactly matches expected value";
-        readonly category: "deterministic";
-        readonly shortDescription: "Passes when output is an exact match";
-        readonly configFields: readonly [{
-            readonly key: "targetOutputKey";
-            readonly label: "Target Output Key";
-            readonly type: "targetOutputKey";
-            readonly required: false;
-            readonly description: "The key in the output to evaluate";
-        }, {
-            readonly key: "caseSensitive";
-            readonly label: "Case Sensitive";
-            readonly type: "boolean";
-            readonly required: false;
-            readonly default: false;
-            readonly description: "If true, the comparison is case-sensitive";
-        }, {
-            readonly key: "negated";
-            readonly label: "Negated";
-            readonly type: "boolean";
-            readonly required: false;
-            readonly default: false;
-            readonly description: "If true, the evaluation passes when the match is not found";
-        }];
-        readonly criteriaFields: readonly [{
-            readonly key: "expectedOutput";
-            readonly label: "Expected Output";
-            readonly type: "object";
-            readonly required: false;
-            readonly description: "The expected output value for this evaluator";
-        }];
-        readonly examples: {
-            readonly criteria: {
-                readonly expectedOutput: {
-                    readonly value: "Application approved";
-                };
-            };
-        };
-    };
-    readonly "uipath-json-similarity": {
-        readonly name: "JSON Similarity";
-        readonly description: "Compare JSON output similarity";
-        readonly category: "deterministic";
-        readonly shortDescription: "Passes when JSON structures are similar";
-        readonly configFields: readonly [{
-            readonly key: "targetOutputKey";
-            readonly label: "Target Output Key";
-            readonly type: "targetOutputKey";
-            readonly required: false;
-            readonly description: "The key in the output to evaluate";
-        }];
-        readonly criteriaFields: readonly [{
-            readonly key: "expectedOutput";
-            readonly label: "Expected Output";
-            readonly type: "object";
-            readonly required: false;
-            readonly description: "The expected output value for this evaluator";
-        }];
-        readonly examples: {
-            readonly criteria: {
-                readonly expectedOutput: {
-                    readonly status: "ok";
-                };
-            };
-        };
-    };
-};

package/dist/services/flow-eval-schema/evaluator-fields.d.ts

@@ -1,66 +0,0 @@
-import type { EvaluatorFieldDefinition } from "./types.js";
-export declare const targetOutputKeyConfigField: {
-    readonly key: "targetOutputKey";
-    readonly label: "Target Output Key";
-    readonly type: "targetOutputKey";
-    readonly required: false;
-    readonly description: "The key in the output to evaluate";
-};
-export declare const caseSensitiveConfigField: {
-    readonly key: "caseSensitive";
-    readonly label: "Case Sensitive";
-    readonly type: "boolean";
-    readonly required: false;
-    readonly default: false;
-    readonly description: "If true, the comparison is case-sensitive";
-};
-export declare const negatedConfigField: {
-    readonly key: "negated";
-    readonly label: "Negated";
-    readonly type: "boolean";
-    readonly required: false;
-    readonly default: false;
-    readonly description: "If true, the evaluation passes when the match is not found";
-};
-export declare const expectedOutputCriteriaField: {
-    readonly key: "expectedOutput";
-    readonly label: "Expected Output";
-    readonly type: "object";
-    readonly required: false;
-    readonly description: "The expected output value for this evaluator";
-};
-export declare const llmBaseConfigFields: readonly [{
-    readonly key: "model";
-    readonly label: "Model";
-    readonly type: "llmModel";
-    readonly required: true;
-    readonly description: "The LLM model to use for judging";
-}, {
-    readonly key: "prompt";
-    readonly label: "Evaluation Prompt";
-    readonly type: "string";
-    readonly required: true;
-    readonly default: "As an expert evaluator, analyze the semantic similarity of these JSON contents to determine a score from 0-100. Focus on comparing the meaning and contextual equivalence of corresponding fields, accounting for alternative valid expressions, synonyms, and reasonable variations in language while maintaining high standards for accuracy and completeness. Provide your score with a justification, explaining briefly and concisely why you gave that score.\n----\nExpectedOutput:\n{{ExpectedOutput}}\n----\nActualOutput:\n{{ActualOutput}}\n";
-    readonly description: "Custom prompt template for the LLM judge";
-}, {
-    readonly key: "temperature";
-    readonly label: "Temperature";
-    readonly type: "number";
-    readonly required: true;
-    readonly default: 0;
-    readonly min: 0;
-    readonly max: 2;
-    readonly step: 0.1;
-    readonly description: "Temperature for LLM generation";
-}, {
-    readonly key: "maxTokens";
-    readonly label: "Max Tokens";
-    readonly type: "number";
-    readonly required: true;
-    readonly default: 8192;
-    readonly min: 0;
-    readonly max: 16384;
-    readonly step: 256;
-    readonly description: "Maximum tokens for LLM response";
-}];
-export declare const llmTrajectoryBaseConfigFields: readonly EvaluatorFieldDefinition[];

package/dist/services/flow-eval-schema/helpers.d.ts

@@ -1,9 +0,0 @@
-import { type EvaluatorTypeId } from "./registry.js";
-import type { EvaluatorTypeDefinition } from "./types.js";
-export declare function evaluatorTypeAliases(): string[];
-export declare function isEvaluatorTypeId(value: string): value is EvaluatorTypeId;
-export declare function getEvaluatorTypeDefinition(typeId: string): EvaluatorTypeDefinition | null;
-export declare function resolveEvaluatorType(type: string): EvaluatorTypeId;
-export declare function getDefaultConfigForEvaluatorType(typeId: EvaluatorTypeId): Record<string, unknown>;
-export declare function evaluatorTypeHasConfigField(typeId: string, fieldKey: string): boolean;
-export declare function evaluatorCanUseSharedExpectedOutput(typeId: string): boolean;

package/dist/services/flow-eval-schema/index.d.ts

@@ -1,4 +0,0 @@
-export * from "./helpers.js";
-export * from "./prompts.js";
-export * from "./registry.js";
-export * from "./types.js";