@uipath/maestro-sdk 1.1.0 → 1.195.0
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.
- package/dist/bpmn-validation/project-validator.js +29 -2
- package/dist/index.js +30908 -19501
- package/dist/manifest/bpmn-spec.js +4 -0
- package/dist/src/debug-service.d.ts +29 -1
- package/dist/src/debug-types.d.ts +1 -0
- package/dist/src/flags/manifest-flags.d.ts +1 -0
- package/dist/src/index.d.ts +1 -1
- package/dist/src/registry/filter-engine.d.ts +3 -3
- package/dist/src/registry/index.d.ts +2 -2
- package/dist/src/registry/node-storage.d.ts +31 -3
- package/dist/src/registry/node-sync-service.d.ts +6 -0
- package/dist/src/registry/solution-discovery.d.ts +12 -0
- package/package.json +41 -51
|
@@ -2969,10 +2969,14 @@ var STATIC_UIPATH_EXTENSION_TAG_NAMES = [
|
|
|
2969
2969
|
"caseManagement",
|
|
2970
2970
|
"context",
|
|
2971
2971
|
"entryPointId",
|
|
2972
|
+
"error",
|
|
2973
|
+
"errorDefinition",
|
|
2974
|
+
"errorMapping",
|
|
2972
2975
|
"input",
|
|
2973
2976
|
"inputOutput",
|
|
2974
2977
|
"inputSchema",
|
|
2975
2978
|
"intsvcActivityConfig",
|
|
2979
|
+
"isTransactionRoot",
|
|
2976
2980
|
"loopCharacteristics",
|
|
2977
2981
|
"migrationVersion",
|
|
2978
2982
|
"output",
|
|
@@ -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, DebugInstanceResponse, DebugInstanceStatusResponse, DebugResult, InlineAgentDescriptor, OrchestratorApiConfig, StudioWebDebugConfig } from "./debug-types";
|
|
6
|
+
import type { BeginSessionResponse, DebugCallbacks, DebugIncidentResponse, DebugInstanceResponse, DebugInstanceStatusResponse, DebugResult, InlineAgentDescriptor, OrchestratorApiConfig, 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.
|
|
@@ -117,6 +117,34 @@ export declare function createDebugInstance(config: OrchestratorApiConfig, jobKe
|
|
|
117
117
|
* Poll PIMS debug instance element-executions until terminal status.
|
|
118
118
|
*/
|
|
119
119
|
export declare function pollDebugInstanceStatus(config: OrchestratorApiConfig, instanceId: string, callbacks?: DebugCallbacks, pollInterval?: number, maxPolls?: number, jobKey?: string): Promise<DebugInstanceStatusResponse>;
|
|
120
|
+
/**
|
|
121
|
+
* Fetch the incident list PIMS recorded against a finished debug instance.
|
|
122
|
+
*
|
|
123
|
+
* Mirrors the `uip <product> debug-instance incidents <id>` command but exposes
|
|
124
|
+
* the raw array so the debug lifecycle can inline it onto {@link DebugResult}.
|
|
125
|
+
* Returns an empty array if the backend reports no incidents.
|
|
126
|
+
*/
|
|
127
|
+
export declare function fetchDebugInstanceIncidents(config: OrchestratorApiConfig, instanceId: string): Promise<DebugIncidentResponse[]>;
|
|
128
|
+
/**
|
|
129
|
+
* True when a poll-loop terminal status should pull incidents inline so the
|
|
130
|
+
* caller can surface them without a follow-up command.
|
|
131
|
+
*/
|
|
132
|
+
export declare function isFaultedDebugStatus(status: string): boolean;
|
|
133
|
+
/**
|
|
134
|
+
* True when a terminal debug status means the run succeeded. Callers should use
|
|
135
|
+
* this (rather than hand-comparing against "Completed"/"Successful") so the
|
|
136
|
+
* success / fault partition stays defined in exactly one place.
|
|
137
|
+
*/
|
|
138
|
+
export declare function isSuccessfulDebugStatus(status: string): boolean;
|
|
139
|
+
/**
|
|
140
|
+
* Best-effort incident lookup for a finished debug run. Returns the incident
|
|
141
|
+
* array only when the run reached a terminal-fault status AND PIMS recorded at
|
|
142
|
+
* least one incident; returns `undefined` otherwise.
|
|
143
|
+
*
|
|
144
|
+
* A fetch failure (404 / permission glitch) is logged and swallowed so it can
|
|
145
|
+
* never mask the original debug result — the incident detail is informational.
|
|
146
|
+
*/
|
|
147
|
+
export declare function resolveFaultIncidents(config: OrchestratorApiConfig, instanceId: string, status: string): Promise<DebugIncidentResponse[] | undefined>;
|
|
120
148
|
/**
|
|
121
149
|
* Parameters for the shared upload-and-debug lifecycle.
|
|
122
150
|
* Callers are responsible for building the .uis package and resolving
|
|
@@ -2,5 +2,6 @@
|
|
|
2
2
|
export declare const FLAG_CONNECTOR_NODES = "canvas.mfe.dap-component";
|
|
3
3
|
export declare const FLAG_EXTRACT_DOCUMENT = "canvas.nodes.extract-document";
|
|
4
4
|
export declare const FLAG_HITL = "canvas.nodes.hitl";
|
|
5
|
+
export declare const FLAG_LOOP_CONTAINER = "canvas.nodes.loop-container";
|
|
5
6
|
/** Returns a `getFeatureFlag` callback that enables the given flags. */
|
|
6
7
|
export declare function buildFeatureFlagResolver(flags: readonly string[]): (flag: string) => boolean;
|
package/dist/src/index.d.ts
CHANGED
|
@@ -5,7 +5,7 @@ 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, getFolderInfoById, getPersonalFolderInfo, getPersonalFolderKey, injectInlineAgentProcessEntries, patchConnectionOverwrites, pollDebugInstanceStatus, prepareForCustomDebug, uploadAndDebugSolution, } 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
9
|
export type { BeginSessionResponse, BreakpointUpdateRequest, ContinueOnBreakpointRequest, DebugCallbacks, DebugGetAllVariablesResponse, DebugGetVariablesResponse, DebugIncidentResponse, DebugInstanceResponse, DebugInstanceStatusResponse, DebugInstanceStatusResult, DebugResult, DebugVariablesResponse, ElementExecution, InlineAgentDescriptor, OrchestratorApiConfig, PatchVariablesRequest, 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";
|
|
@@ -1,11 +1,11 @@
|
|
|
1
|
-
import type {
|
|
1
|
+
import type { SearchableNode } from "./node-storage.js";
|
|
2
2
|
import type { ParsedFilters } from "./types";
|
|
3
3
|
/**
|
|
4
4
|
* Filter nodes based on provided filter conditions
|
|
5
5
|
*/
|
|
6
|
-
export declare function filterNodes(nodes:
|
|
6
|
+
export declare function filterNodes<T extends SearchableNode>(nodes: T[], parsedFilters: ParsedFilters): T[];
|
|
7
7
|
/**
|
|
8
8
|
* Advanced search with filters and keyword
|
|
9
9
|
* Combines filter conditions with keyword search
|
|
10
10
|
*/
|
|
11
|
-
export declare function searchWithFilters(nodes:
|
|
11
|
+
export declare function searchWithFilters<T extends SearchableNode>(nodes: T[], keyword?: string, filters?: ParsedFilters): T[];
|
|
@@ -1,11 +1,11 @@
|
|
|
1
|
-
export { buildFeatureFlagResolver, FLAG_CONNECTOR_NODES, FLAG_EXTRACT_DOCUMENT, FLAG_HITL, } from "../flags/manifest-flags.js";
|
|
1
|
+
export { buildFeatureFlagResolver, FLAG_CONNECTOR_NODES, FLAG_EXTRACT_DOCUMENT, FLAG_HITL, FLAG_LOOP_CONTAINER, } from "../flags/manifest-flags.js";
|
|
2
2
|
export { registerRegistryCommand } from "./command.js";
|
|
3
3
|
export { filterNodes, searchWithFilters, } from "./filter-engine.js";
|
|
4
4
|
export { FilterParseError, parseFilterString } from "./filter-parser.js";
|
|
5
5
|
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
6
|
export type { CompactField, ConnectorInfo, ConnectorMethodInfo, ContextEntry, FieldReference, ISField, ISFieldMethod, ISMetadata, ISMetadataParam, TriggerField, TriggerFieldEvent, TriggerObjectMetadata, } from "./integration-service-metadata.types";
|
|
7
7
|
export { isKnownSdkNodeType, listKnownSdkNodes } from "./known-types.js";
|
|
8
|
-
export { hashContent, loadIndexMetadata, loadNodeIndex, resolveNodeStorageDir, type SyncMetadata, saveIndexMetadata, saveNodeIndex, } from "./node-storage.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";
|
|
9
9
|
export { getNode, getNodeEnriched, listNodes, pullNodes, pullRemoteNodes, searchNodes, searchNodesWithFilters, } from "./node-sync-service.js";
|
|
10
10
|
export type { SolutionContext } from "./solution-discovery.js";
|
|
11
11
|
export { buildInSolutionNodeManifests, findSolutionFromCwd, readProjectEntryPointIO, } from "./solution-discovery.js";
|
|
@@ -1,4 +1,24 @@
|
|
|
1
1
|
import type { NodeManifest } from "@uipath/flow-core";
|
|
2
|
+
export declare const CACHE_FORMAT_VERSION = 1;
|
|
3
|
+
export interface SearchableNode {
|
|
4
|
+
nodeType?: string;
|
|
5
|
+
category?: string;
|
|
6
|
+
tags?: string[];
|
|
7
|
+
version?: string;
|
|
8
|
+
description?: string;
|
|
9
|
+
display?: {
|
|
10
|
+
label?: string;
|
|
11
|
+
description?: string;
|
|
12
|
+
};
|
|
13
|
+
[key: string]: unknown;
|
|
14
|
+
}
|
|
15
|
+
export type NodeSearchSummary = SearchableNode;
|
|
16
|
+
export interface DerivedArtifact<T> {
|
|
17
|
+
cacheVersion: number;
|
|
18
|
+
sourceHash: string;
|
|
19
|
+
generatedAt: number;
|
|
20
|
+
nodes: T[];
|
|
21
|
+
}
|
|
2
22
|
/**
|
|
3
23
|
* Metadata about a node source sync operation
|
|
4
24
|
*/
|
|
@@ -6,6 +26,7 @@ export interface SyncMetadata {
|
|
|
6
26
|
lastSync: number;
|
|
7
27
|
nodeCount: number;
|
|
8
28
|
hash: string;
|
|
29
|
+
cacheVersion?: number;
|
|
9
30
|
}
|
|
10
31
|
/**
|
|
11
32
|
* Resolve the absolute path to the nodes storage directory.
|
|
@@ -21,10 +42,13 @@ export declare function resolveNodeStorageDir(): Promise<string>;
|
|
|
21
42
|
* @returns Hex string of the hash
|
|
22
43
|
*/
|
|
23
44
|
export declare function hashContent(content: string): Promise<string>;
|
|
45
|
+
export declare function buildSearchIndex(nodes: NodeManifest[]): NodeSearchSummary[];
|
|
46
|
+
export declare function isEssentialNodeType(nodeType: string | undefined): boolean;
|
|
47
|
+
export declare function buildEssentialsIndex(nodes: NodeManifest[]): NodeManifest[];
|
|
24
48
|
/**
|
|
25
|
-
* Save nodes directly to the index file
|
|
26
|
-
* Bypasses the source aggregation and saves nodes directly
|
|
27
|
-
* Also updates the index metadata
|
|
49
|
+
* Save nodes directly to the index file.
|
|
50
|
+
* Bypasses the source aggregation and saves nodes directly.
|
|
51
|
+
* Also updates the index metadata and derived read-path artifacts.
|
|
28
52
|
*
|
|
29
53
|
* @param nodes - Array of nodes to save
|
|
30
54
|
* @returns Number of nodes saved
|
|
@@ -49,3 +73,7 @@ export declare function saveIndexMetadata(metadata: SyncMetadata): Promise<void>
|
|
|
49
73
|
* @returns Metadata if exists, null otherwise
|
|
50
74
|
*/
|
|
51
75
|
export declare function loadIndexMetadata(): Promise<SyncMetadata | null>;
|
|
76
|
+
export declare function loadValidSearchIndex(): Promise<NodeSearchSummary[] | null>;
|
|
77
|
+
export declare function loadValidEssentialsIndex(): Promise<NodeManifest[] | null>;
|
|
78
|
+
export declare function areDerivedArtifactsCurrent(): Promise<boolean>;
|
|
79
|
+
export declare function rederiveNodeIndexArtifacts(): Promise<number>;
|
|
@@ -1,4 +1,5 @@
|
|
|
1
1
|
import type { NodeManifest } from "@uipath/flow-core";
|
|
2
|
+
import { type NodeSearchSummary } from "./node-storage.js";
|
|
2
3
|
import type { ParsedFilters } from "./types";
|
|
3
4
|
interface PullNodesOptions {
|
|
4
5
|
force?: boolean;
|
|
@@ -45,6 +46,11 @@ export declare function pullRemoteNodes(): Promise<PullRemoteNodesResult>;
|
|
|
45
46
|
export declare function listNodes(options?: {
|
|
46
47
|
local?: boolean;
|
|
47
48
|
}): Promise<NodeManifest[]>;
|
|
49
|
+
interface SearchSummaryWithAvailability {
|
|
50
|
+
node: NodeSearchSummary;
|
|
51
|
+
availableOnTenant: boolean;
|
|
52
|
+
}
|
|
53
|
+
export declare function searchNodeSummariesWithAvailability(keyword?: string, filters?: ParsedFilters): Promise<SearchSummaryWithAvailability[]>;
|
|
48
54
|
/**
|
|
49
55
|
* Search for nodes by keyword
|
|
50
56
|
* Searches across nodeType, category, tags, and display.label
|
|
@@ -20,6 +20,18 @@ export declare function findSolutionFromCwd(): Promise<SolutionContext | null>;
|
|
|
20
20
|
/**
|
|
21
21
|
* Read entry-points.json from a project directory.
|
|
22
22
|
* Tries flat layout first, then content/ subdirectory.
|
|
23
|
+
*
|
|
24
|
+
* Falls back to extracting `variables.globals` from the project's `.flow`
|
|
25
|
+
* file whenever no usable `entry-points.json` is found in either candidate
|
|
26
|
+
* location — that is, when the file is missing, unreadable, contains
|
|
27
|
+
* invalid JSON, or carries an empty `entryPoints` array. `flow init` and
|
|
28
|
+
* `flow variable add` do not emit `entry-points.json` — the packager
|
|
29
|
+
* generates it into a temp staging dir at pack time — so without this
|
|
30
|
+
* fallback the in-solution registry would always report empty
|
|
31
|
+
* inputDefinition/outputDefinition for unpacked source flow projects. The
|
|
32
|
+
* broader trigger (not strictly ENOENT) is intentional: a corrupted or
|
|
33
|
+
* stale `entry-points.json` should still let the `.flow` source recover
|
|
34
|
+
* the typed contract.
|
|
23
35
|
*/
|
|
24
36
|
export declare function readProjectEntryPointIO(projectDir: string): Promise<ProjectEntryPointIO>;
|
|
25
37
|
/**
|
package/package.json
CHANGED
|
@@ -1,56 +1,46 @@
|
|
|
1
1
|
{
|
|
2
|
-
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
2
|
+
"name": "@uipath/maestro-sdk",
|
|
3
|
+
"license": "MIT",
|
|
4
|
+
"version": "1.195.0",
|
|
5
|
+
"description": "SDK for the UiPath Maestro (PIMS) API — process instance management.",
|
|
6
|
+
"repository": {
|
|
7
|
+
"type": "git",
|
|
8
|
+
"url": "https://github.com/UiPath/cli.git",
|
|
9
|
+
"directory": "packages/maestro-sdk"
|
|
10
|
+
},
|
|
11
|
+
"publishConfig": {
|
|
12
|
+
"registry": "https://registry.npmjs.org/"
|
|
13
|
+
},
|
|
14
|
+
"keywords": [
|
|
15
|
+
"uipath",
|
|
16
|
+
"maestro",
|
|
17
|
+
"pims",
|
|
18
|
+
"sdk"
|
|
19
|
+
],
|
|
20
|
+
"type": "module",
|
|
21
|
+
"main": "./dist/index.js",
|
|
22
|
+
"types": "./dist/src/index.d.ts",
|
|
23
|
+
"exports": {
|
|
24
|
+
".": {
|
|
25
|
+
"types": "./dist/src/index.d.ts",
|
|
26
|
+
"default": "./dist/index.js"
|
|
9
27
|
},
|
|
10
|
-
"
|
|
11
|
-
|
|
28
|
+
"./manifest/bpmn-spec": {
|
|
29
|
+
"types": "./dist/src/manifest/bpmn-spec.d.ts",
|
|
30
|
+
"import": "./dist/manifest/bpmn-spec.js",
|
|
31
|
+
"default": "./dist/manifest/bpmn-spec.js"
|
|
12
32
|
},
|
|
13
|
-
"
|
|
14
|
-
|
|
15
|
-
"maestro",
|
|
16
|
-
"pims",
|
|
17
|
-
"sdk"
|
|
18
|
-
],
|
|
19
|
-
"type": "module",
|
|
20
|
-
"main": "./dist/index.js",
|
|
21
|
-
"types": "./dist/src/index.d.ts",
|
|
22
|
-
"exports": {
|
|
23
|
-
".": {
|
|
24
|
-
"types": "./dist/src/index.d.ts",
|
|
25
|
-
"default": "./dist/index.js"
|
|
26
|
-
},
|
|
27
|
-
"./manifest/bpmn-spec": {
|
|
28
|
-
"types": "./dist/src/manifest/bpmn-spec.d.ts",
|
|
29
|
-
"import": "./dist/manifest/bpmn-spec.js",
|
|
30
|
-
"default": "./dist/manifest/bpmn-spec.js"
|
|
31
|
-
},
|
|
32
|
-
"./manifest/types": {
|
|
33
|
-
"types": "./dist/src/manifest/types.d.ts"
|
|
34
|
-
},
|
|
35
|
-
"./bpmn-validation": {
|
|
36
|
-
"types": "./dist/src/bpmn-validation/project-validator.d.ts",
|
|
37
|
-
"import": "./dist/bpmn-validation/project-validator.js",
|
|
38
|
-
"default": "./dist/bpmn-validation/project-validator.js"
|
|
39
|
-
}
|
|
33
|
+
"./manifest/types": {
|
|
34
|
+
"types": "./dist/src/manifest/types.d.ts"
|
|
40
35
|
},
|
|
41
|
-
"
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
|
|
45
|
-
|
|
46
|
-
|
|
47
|
-
|
|
48
|
-
|
|
49
|
-
|
|
50
|
-
|
|
51
|
-
"@types/node": "^25.5.2",
|
|
52
|
-
"commander": "^14.0.3",
|
|
53
|
-
"typescript": "^6.0.2"
|
|
54
|
-
},
|
|
55
|
-
"gitHead": "06e8c8f566df4b87da4a008635483c62f64f33f0"
|
|
36
|
+
"./bpmn-validation": {
|
|
37
|
+
"types": "./dist/src/bpmn-validation/project-validator.d.ts",
|
|
38
|
+
"import": "./dist/bpmn-validation/project-validator.js",
|
|
39
|
+
"default": "./dist/bpmn-validation/project-validator.js"
|
|
40
|
+
}
|
|
41
|
+
},
|
|
42
|
+
"files": [
|
|
43
|
+
"dist"
|
|
44
|
+
],
|
|
45
|
+
"gitHead": "65fabb84552758b2710d8ca68470e70a9b1d19bc"
|
|
56
46
|
}
|