@uipath/maestro-sdk 1.195.0 → 1.196.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -3,7 +3,7 @@
3
3
  * Provides common methods used by flow-tool, case-tool, and maestro-tool.
4
4
  */
5
5
  import type { IFileSystem } from "@uipath/filesystem";
6
- import type { BeginSessionResponse, DebugCallbacks, DebugIncidentResponse, DebugInstanceResponse, DebugInstanceStatusResponse, DebugResult, InlineAgentDescriptor, OrchestratorApiConfig, StudioWebDebugConfig } from "./debug-types";
6
+ import type { BeginSessionResponse, DebugCallbacks, DebugIncidentResponse, DebugInstanceResponse, DebugInstanceStatusResponse, DebugResult, InlineAgentDescriptor, OrchestratorApiConfig, SolutionProjectDescriptor, StudioWebDebugConfig } from "./debug-types";
7
7
  /**
8
8
  * Thrown by {@link injectInlineAgentProcessEntries} when `FpsProperties`
9
9
  * is not valid JSON and inline agents need to be injected.
@@ -27,6 +27,22 @@ export declare class FpsPropertiesInjectionError extends Error {
27
27
  * `fpsProperties` cannot be parsed.
28
28
  */
29
29
  export declare function injectInlineAgentProcessEntries(fpsProperties: string | undefined, inlineAgents?: InlineAgentDescriptor[]): string | undefined;
30
+ /**
31
+ * Append in-solution sibling-project entries (flow-as-node callees, RPA
32
+ * processes, …) to `FpsProperties.debug.master.processes`. The flow-as-node
33
+ * analogue of {@link injectInlineAgentProcessEntries}: each entry carries an
34
+ * `executorInfo.debugArgs` envelope so the runtime can start the child as its
35
+ * own debug instance when the lead flow fires `Orchestrator.StartAgenticProcess`.
36
+ * When no projects are supplied, the input is returned unchanged.
37
+ *
38
+ * Mirrors the `debug.master.processes` shape captured from a working Studio
39
+ * Web debug session. Without these entries the runtime returns 404 "the job's
40
+ * associated process could not be found" (170007).
41
+ *
42
+ * @throws {FpsPropertiesInjectionError} when projects are supplied and
43
+ * `fpsProperties` cannot be parsed.
44
+ */
45
+ export declare function injectSolutionProjectProcessEntries(fpsProperties: string | undefined, solutionProjects?: SolutionProjectDescriptor[]): string | undefined;
30
46
  /**
31
47
  * Extract the first bpmn:startEvent id from BPMN XML.
32
48
  * Falls back to "start" if no start event is found.
@@ -89,19 +105,27 @@ export interface BeginDebugSessionOptions {
89
105
  /** Inline agents to register with the debug session via FpsProperties. */
90
106
  inlineAgents?: InlineAgentDescriptor[];
91
107
  /**
92
- * Pre-existing `FpsProperties` JSON string. Inline agents (when
93
- * supplied) are appended into `debug.master.processes` on top of this.
108
+ * In-solution sibling projects (flow-as-node callees, RPA processes, …) to
109
+ * register in `debug.master.processes` so their `StartAgenticProcess`
110
+ * activity can resolve the child the same way inline agents resolve
111
+ * `StartInlineAgentJob`.
112
+ */
113
+ solutionProjects?: SolutionProjectDescriptor[];
114
+ /**
115
+ * Pre-existing `FpsProperties` JSON string. Inline agents and solution
116
+ * projects (when supplied) are appended into `debug.master.processes` on
117
+ * top of this.
94
118
  */
95
119
  fpsProperties?: string;
96
120
  }
97
121
  /**
98
122
  * Begin a debug session in Orchestrator.
99
123
  *
100
- * When `options.inlineAgents` is non-empty, each agent is encoded into
124
+ * `options.inlineAgents` / `options.solutionProjects` are each encoded into
101
125
  * `FpsProperties.debug.master.processes` so the runtime can resolve the
102
- * `Orchestrator.StartInlineAgentJob` activity that fires for each agent
103
- * node — without it Orchestrator returns 404 "the job's associated
104
- * process could not be found".
126
+ * `Orchestrator.StartInlineAgentJob` / `StartAgenticProcess` activity that
127
+ * fires for each agent / flow-as-node — without it Orchestrator returns 404
128
+ * "the job's associated process could not be found".
105
129
  */
106
130
  export declare function beginDebugSession(config: OrchestratorApiConfig, inputArguments?: string, options?: BeginDebugSessionOptions): Promise<BeginSessionResponse>;
107
131
  export declare const DEBUG_MODE_MAP: Record<string, number>;
@@ -184,6 +208,25 @@ export interface UploadAndDebugParams {
184
208
  * agent's `Orchestrator.StartInlineAgentJob` lookup.
185
209
  */
186
210
  inlineAgents?: InlineAgentDescriptor[];
211
+ /**
212
+ * Build the in-solution sibling-project descriptors (flow-as-node callees,
213
+ * …) to register in `debug.master.processes`. Invoked AFTER upload with the
214
+ * Studio Web-minted project ids and the uploaded solution id, so each
215
+ * descriptor's `projectId`/`solutionId` match the uploaded solution. The
216
+ * callback lives on the caller (flow-tool) because per-project type +
217
+ * entry point come from the on-disk solution, which maestro-sdk doesn't read.
218
+ */
219
+ buildSolutionProjects?: (uploadedProjects: Array<{
220
+ id: string;
221
+ name: string;
222
+ }>, solutionId: string) => Promise<SolutionProjectDescriptor[]> | SolutionProjectDescriptor[];
223
+ /**
224
+ * Solution name passed to {@link prepareForCustomDebug}. Surfaces in
225
+ * Studio Web's debug-solution metadata; falls back to `projectName` when
226
+ * omitted. Has no effect on routing — Orchestrator only cares that the
227
+ * resource-builder call returned the debug IDs.
228
+ */
229
+ solutionName?: string;
187
230
  }
188
231
  /**
189
232
  * Shared upload-and-debug lifecycle used by flow-tool, maestro-tool, and case-tool.
@@ -63,6 +63,38 @@ export interface InlineAgentDescriptor {
63
63
  */
64
64
  entryPointPath: string;
65
65
  }
66
+ /**
67
+ * Describes an in-solution sibling project (a flow-as-node callee, RPA
68
+ * process, …) that the debug session must register so the lead flow can start
69
+ * it as a child. Studio Web encodes one entry per solution project into
70
+ * `FpsProperties.debug.master.processes`; the runtime resolves
71
+ * `Orchestrator.StartAgenticProcess` against that session-scoped registry by
72
+ * NAME (no deployed Orchestrator release is involved).
73
+ *
74
+ * This is the flow-as-node analogue of {@link InlineAgentDescriptor}: the
75
+ * difference is the `executorInfo` payload — a flow callee carries a
76
+ * `debugArgs` envelope ({@link entryPoint}, {@link solutionId}, debug mode)
77
+ * instead of an agent entry point. Without these entries the runtime returns
78
+ * 404 "the job's associated process could not be found" (170007).
79
+ */
80
+ export interface SolutionProjectDescriptor {
81
+ /** Project name — the key the runtime resolves `StartAgenticProcess` by. */
82
+ name: string;
83
+ /** Studio Web-minted project id from the solution upload result. */
84
+ projectId: string;
85
+ /** Wire project type stamped on the entry (e.g. `Flow`). */
86
+ projectType: string;
87
+ /**
88
+ * Per-project entry point: `<bpmn-file>#<start-node>` relative to the
89
+ * package content root — NO leading slash and NO `content/` prefix
90
+ * (matches what Studio Web sends).
91
+ */
92
+ entryPoint: string;
93
+ /** Uploaded solution id — carried into `executorInfo.debugArgs.solutionId`. */
94
+ solutionId: string;
95
+ /** PIMS debug mode for the child (Default = 1). Defaults to 1. */
96
+ debugMode?: number;
97
+ }
66
98
  export interface ElementExecution {
67
99
  elementId: string;
68
100
  elementType?: string;
@@ -5,14 +5,14 @@ export { createPimsConfig } from "./client-factory";
5
5
  export type { DebugApiService, MaestroHttpErrorDetails, } from "./debug-http-client";
6
6
  export { debugPimsGet, debugPimsPatch, debugPimsPost, debugPimsPut, MaestroHttpError, orchestratorGet, orchestratorPost, parseBackendErrorBody, studioWebDelete, studioWebPost, } from "./debug-http-client";
7
7
  export type { BeginDebugSessionOptions, PersonalFolderInfo, PrepareForCustomDebugParams, PrepareForCustomDebugResponse, UploadAndDebugParams, } from "./debug-service";
8
- export { beginDebugSession, createDebugInstance, extractStartEventId, FpsPropertiesInjectionError, fetchDebugInstanceIncidents, getFolderInfoById, getPersonalFolderInfo, getPersonalFolderKey, injectInlineAgentProcessEntries, isFaultedDebugStatus, isSuccessfulDebugStatus, patchConnectionOverwrites, pollDebugInstanceStatus, prepareForCustomDebug, resolveFaultIncidents, uploadAndDebugSolution, } from "./debug-service";
9
- export type { BeginSessionResponse, BreakpointUpdateRequest, ContinueOnBreakpointRequest, DebugCallbacks, DebugGetAllVariablesResponse, DebugGetVariablesResponse, DebugIncidentResponse, DebugInstanceResponse, DebugInstanceStatusResponse, DebugInstanceStatusResult, DebugResult, DebugVariablesResponse, ElementExecution, InlineAgentDescriptor, OrchestratorApiConfig, PatchVariablesRequest, StudioWebDebugConfig, } from "./debug-types";
8
+ export { beginDebugSession, createDebugInstance, extractStartEventId, FpsPropertiesInjectionError, fetchDebugInstanceIncidents, getFolderInfoById, getPersonalFolderInfo, getPersonalFolderKey, injectInlineAgentProcessEntries, injectSolutionProjectProcessEntries, isFaultedDebugStatus, isSuccessfulDebugStatus, patchConnectionOverwrites, pollDebugInstanceStatus, prepareForCustomDebug, resolveFaultIncidents, uploadAndDebugSolution, } from "./debug-service";
9
+ export type { BeginSessionResponse, BreakpointUpdateRequest, ContinueOnBreakpointRequest, DebugCallbacks, DebugGetAllVariablesResponse, DebugGetVariablesResponse, DebugIncidentResponse, DebugInstanceResponse, DebugInstanceStatusResponse, DebugInstanceStatusResult, DebugResult, DebugVariablesResponse, ElementExecution, InlineAgentDescriptor, OrchestratorApiConfig, PatchVariablesRequest, SolutionProjectDescriptor, StudioWebDebugConfig, } from "./debug-types";
10
10
  export { parseJsonInputOrFile, readJsonFile, resolveJsonInput, } from "./json-input";
11
11
  export { BPMN_SPEC, SUPPORTED_UIPATH_EXTENSION_TAG_NAMES, SUPPORTED_UIPATH_EXTENSION_TAGS, } from "./manifest/bpmn-spec";
12
12
  export type { BpmnExtensionType, DiscoveredConnector, DiscoveredProcess, MaestroRegistry, RegistryMetadata, } from "./manifest/types";
13
13
  export { buildQueryString } from "./query-string";
14
14
  export type { CompactField, ConnectorInfo, ConnectorMethodInfo, ContextEntry, FieldReference, FilterCondition, FilterField, FilterOperator, ISField, ISFieldMethod, ISMetadata, ISMetadataParam, ParsedFilters, SyncMetadata, TriggerField, TriggerFieldEvent, TriggerObjectMetadata, } from "./registry/index.js";
15
- export { buildActivityEssentialConfiguration, buildInputMetadata, buildManagedHttpEssentialConfiguration, buildTriggerEssentialConfiguration, enrichConnectorNode, extractActivityFilterFields, extractMultipartParameters, extractTriggerEventParameters, extractTriggerFilterFields, FilterParseError, fetchConnectionInfo, fetchConnectorMetadata, fetchConnectorTriggerMetadata, filterNodes, getConnectorConfiguration, getConnectorInfo, getNode, getNodeEnriched, hashContent, inlineMultipartFileValues, isConnectorNode, isConnectorTriggerNode, isKnownSdkNodeType, listKnownSdkNodes, listNodes, loadIndexMetadata, loadNodeIndex, MANAGED_HTTP_CONNECTOR_KEY, parseFilterString, pullNodes, pullRemoteNodes, registerRegistryCommand, resolveNodeStorageDir, saveIndexMetadata, saveNodeIndex, searchNodes, searchNodesWithFilters, searchWithFilters, } from "./registry/index.js";
15
+ export { buildActivityEssentialConfiguration, buildInputMetadata, buildManagedHttpEssentialConfiguration, buildTriggerEssentialConfiguration, enrichConnectorNode, extractActivityFilterFields, extractMultipartParameters, extractTriggerEventParameters, extractTriggerFilterFields, FilterParseError, fetchConnectionInfo, fetchConnectorMetadata, fetchConnectorTriggerMetadata, filterNodes, getConnectorConfiguration, getConnectorInfo, getNode, getNodeEnriched, inlineMultipartFileValues, isConnectorNode, isConnectorTriggerNode, isKnownSdkNodeType, listKnownSdkNodes, listNodes, loadIndexMetadata, loadNodeIndex, MANAGED_HTTP_CONNECTOR_KEY, parseFilterString, pullNodes, pullRemoteNodes, registerRegistryCommand, resolveNodeStorageDir, saveIndexMetadata, saveNodeIndex, searchNodes, searchNodesWithFilters, searchWithFilters, } from "./registry/index.js";
16
16
  export { getEnrichedActivityMetadata, getExtensionType, getRegistry, pullRegistry, searchRegistry, } from "./registry/registry-service";
17
17
  export { CACHE_EXPIRATION_MS, loadRegistry, loadRegistryMetadata, saveRegistry, } from "./registry/storage";
18
18
  export type { DebugInstanceCommandsConfig } from "./shared-commands/debug-instances";
@@ -1,11 +1,10 @@
1
- export { buildFeatureFlagResolver, FLAG_CONNECTOR_NODES, FLAG_EXTRACT_DOCUMENT, FLAG_HITL, FLAG_LOOP_CONTAINER, } from "../flags/manifest-flags.js";
2
1
  export { registerRegistryCommand } from "./command.js";
3
2
  export { filterNodes, searchWithFilters, } from "./filter-engine.js";
4
3
  export { FilterParseError, parseFilterString } from "./filter-parser.js";
5
4
  export { buildActivityEssentialConfiguration, buildInputMetadata, buildManagedHttpEssentialConfiguration, buildTriggerEssentialConfiguration, enrichConnectorNode, extractActivityFilterFields, extractMultipartParameters, extractTriggerEventParameters, extractTriggerFilterFields, fetchConnectionInfo, fetchConnectorMetadata, fetchConnectorTriggerMetadata, getConnectorConfiguration, getConnectorInfo, inlineMultipartFileValues, isConnectorNode, isConnectorTriggerNode, MANAGED_HTTP_CONNECTOR_KEY, } from "./integration-service-fetcher.js";
6
5
  export type { CompactField, ConnectorInfo, ConnectorMethodInfo, ContextEntry, FieldReference, ISField, ISFieldMethod, ISMetadata, ISMetadataParam, TriggerField, TriggerFieldEvent, TriggerObjectMetadata, } from "./integration-service-metadata.types";
7
6
  export { isKnownSdkNodeType, listKnownSdkNodes } from "./known-types.js";
8
- export { areDerivedArtifactsCurrent, buildEssentialsIndex, buildSearchIndex, CACHE_FORMAT_VERSION, type DerivedArtifact, hashContent, isEssentialNodeType, loadIndexMetadata, loadNodeIndex, loadValidEssentialsIndex, loadValidSearchIndex, type NodeSearchSummary, rederiveNodeIndexArtifacts, resolveNodeStorageDir, type SearchableNode, type SyncMetadata, saveIndexMetadata, saveNodeIndex, } from "./node-storage.js";
7
+ export { areDerivedArtifactsCurrent, buildEssentialsIndex, buildSearchIndex, CACHE_FORMAT_VERSION, type DerivedArtifact, isEssentialNodeType, loadIndexMetadata, loadNodeIndex, loadValidEssentialsIndex, loadValidSearchIndex, type NodeSearchSummary, rederiveNodeIndexArtifacts, resolveNodeStorageDir, type SearchableNode, type SyncMetadata, saveIndexMetadata, saveNodeIndex, } from "./node-storage.js";
9
8
  export { getNode, getNodeEnriched, listNodes, pullNodes, pullRemoteNodes, searchNodes, searchNodesWithFilters, } from "./node-sync-service.js";
10
9
  export type { SolutionContext } from "./solution-discovery.js";
11
10
  export { buildInSolutionNodeManifests, findSolutionFromCwd, readProjectEntryPointIO, } from "./solution-discovery.js";
@@ -35,13 +35,6 @@ export interface SyncMetadata {
35
35
  * @returns Absolute path to the nodes directory
36
36
  */
37
37
  export declare function resolveNodeStorageDir(): Promise<string>;
38
- /**
39
- * Generate SHA-256 hash of content for change detection
40
- *
41
- * @param content - String content to hash
42
- * @returns Hex string of the hash
43
- */
44
- export declare function hashContent(content: string): Promise<string>;
45
38
  export declare function buildSearchIndex(nodes: NodeManifest[]): NodeSearchSummary[];
46
39
  export declare function isEssentialNodeType(nodeType: string | undefined): boolean;
47
40
  export declare function buildEssentialsIndex(nodes: NodeManifest[]): NodeManifest[];
@@ -30,13 +30,6 @@ interface PullRemoteNodesResult {
30
30
  * @returns Result with sync count and cache status
31
31
  */
32
32
  export declare function pullNodes(options?: PullNodesOptions): Promise<PullNodesResult>;
33
- /**
34
- * Pull remote nodes from the manifest API
35
- * Only pulls if user is logged in
36
- * Fetches all nodes (OOTB + remote) from the manifest
37
- *
38
- * @returns Array of all nodes from manifest
39
- */
40
33
  export declare function pullRemoteNodes(): Promise<PullRemoteNodesResult>;
41
34
  /**
42
35
  * List cached nodes, falling back to live OOTB nodes if no cache exists.
@@ -10,10 +10,6 @@
10
10
  import type { MaestroRegistry, RegistryMetadata } from "../manifest/types.js";
11
11
  /** Cache is considered fresh for 30 minutes. */
12
12
  export declare const CACHE_EXPIRATION_MS: number;
13
- /**
14
- * Generate a SHA-256 hex hash of the given string content.
15
- */
16
- export declare function hashContent(content: string): Promise<string>;
17
13
  /**
18
14
  * Save the full registry to disk and update the companion metadata file.
19
15
  */
@@ -1,6 +1,6 @@
1
+ export { readStdin } from "@uipath/common";
1
2
  export declare const VALID_PROJECT_NAME_REGEX: RegExp;
2
3
  export declare const VALID_PACKAGE_NAME_REGEX: RegExp;
3
- export declare function readStdin(): Promise<string | null>;
4
4
  export interface TraceEvent {
5
5
  timestamp: string;
6
6
  status: string;
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@uipath/maestro-sdk",
3
3
  "license": "MIT",
4
- "version": "1.195.0",
4
+ "version": "1.196.1",
5
5
  "description": "SDK for the UiPath Maestro (PIMS) API — process instance management.",
6
6
  "repository": {
7
7
  "type": "git",
@@ -42,5 +42,5 @@
42
42
  "files": [
43
43
  "dist"
44
44
  ],
45
- "gitHead": "65fabb84552758b2710d8ca68470e70a9b1d19bc"
45
+ "gitHead": "acdb9272c7407276898d24463cae9e377ccb1bf1"
46
46
  }
@@ -1,7 +0,0 @@
1
- /** flow-core feature-flag constants — each gates a node category in ManifestClient. */
2
- export declare const FLAG_CONNECTOR_NODES = "canvas.mfe.dap-component";
3
- export declare const FLAG_EXTRACT_DOCUMENT = "canvas.nodes.extract-document";
4
- export declare const FLAG_HITL = "canvas.nodes.hitl";
5
- export declare const FLAG_LOOP_CONTAINER = "canvas.nodes.loop-container";
6
- /** Returns a `getFeatureFlag` callback that enables the given flags. */
7
- export declare function buildFeatureFlagResolver(flags: readonly string[]): (flag: string) => boolean;