@uipath/solution-tool 1.206.0-preview.301 → 1.207.0-preview.305
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/{archive-extract-ma0gy822.js → archive-extract-afgwacbg.js} +3 -3
- package/dist/{cleanup-command-service-8whhrsvy.js → cleanup-command-service-j9kawew9.js} +20 -15
- package/dist/deploy-delete-service-1erqap9a.js +23 -0
- package/dist/deploy-run-service-jbs6dxye.js +24 -0
- package/dist/{deploy-status-service-at6cxp1a.js → deploy-status-service-4zn90vds.js} +49 -25
- package/dist/deploy.js +21 -20
- package/dist/{deployment-search-40dknsk1.js → deployment-search-dwzahe4v.js} +9 -9
- package/dist/feed-resolver-d14rdjss.js +31 -0
- package/dist/feed-scope-failure-w16mze3z.js +20 -0
- package/dist/{feed-session-dvyfw5k7.js → feed-session-f2sby6t8.js} +6 -6
- package/dist/{first-party-service-6gf3n6d8.js → first-party-service-7cggb17y.js} +1 -1
- package/dist/folder-runtime-check-586c41dq.js +25 -0
- package/dist/{governance-options-am1hfj5b.js → governance-options-y2xsv7ff.js} +7 -7
- package/dist/{packager-tool-5vf0v538.js → index-6ma58k47.js} +33 -708
- package/dist/{index-p3x7ztdr.js → index-795rsz0e.js} +1 -1
- package/dist/{index-yjvmjpdn.js → index-pzkzbqbs.js} +12 -11
- package/dist/{index-1cfw8mj0.js → index-wfqzwh7k.js} +9 -7
- package/dist/index.js +26 -26
- package/dist/init.js +10 -10
- package/dist/{list-vsecskj1.js → list-6pe1nab5.js} +11 -11
- package/dist/models/pack-command-types.d.ts +12 -0
- package/dist/{node-vndr59bc.js → node-13wj5mzd.js} +6 -6
- package/dist/pack-command-service-j9bqnsn1.js +32 -0
- package/dist/{pack-project-re7s480k.js → pack-project-3sdddc42.js} +21 -18
- package/dist/pack.js +25 -22
- package/dist/{package-id-rx8gq6y2.js → package-id-5j4q232a.js} +3 -3
- package/dist/{packager-tool-vgrswa8p.js → packager-tool-1db1wqdy.js} +30 -8
- package/dist/{packager-tool-vx2c68sb.js → packager-tool-1dsxhz1r.js} +2 -2
- package/dist/{packager-tool-t2r6z24f.js → packager-tool-1tvhgac9.js} +15 -6
- package/dist/{packager-tool-4pt71nf1.js → packager-tool-2atxqqgd.js} +49 -24
- package/dist/packager-tool-3ft8hywr.js +449 -0
- package/dist/{packager-tool-g1c0xdh2.js → packager-tool-46x80z85.js} +8 -4
- package/dist/{packager-tool-gjfb0wcy.js → packager-tool-4hm40a32.js} +8 -74
- package/dist/{packager-tool-f15an17m.js → packager-tool-5p1vy335.js} +1 -1
- package/dist/packager-tool-612prgtc.js +140 -0
- package/dist/packager-tool-7gqn5apd.js +72 -0
- package/dist/{packager-tool-aws5w512.js → packager-tool-887bkh9y.js} +1 -1
- package/dist/{packager-tool-vj88gh5b.js → packager-tool-8tckw03n.js} +28 -9
- package/dist/{packager-tool-9vtp28fb.js → packager-tool-93qy1v8m.js} +52 -15
- package/dist/{packager-tool-fx4ws49n.js → packager-tool-cenfraf4.js} +2 -2
- package/dist/{packager-tool-chff74yz.js → packager-tool-cr1khqtm.js} +103 -166
- package/dist/{packager-tool-6tn79r1b.js → packager-tool-da3hvfyn.js} +528 -202
- package/dist/{packager-tool-2zn98p5r.js → packager-tool-dd937g7k.js} +4 -4
- package/dist/{packager-tool-a7s0gbxs.js → packager-tool-devc4w73.js} +7 -2
- package/dist/{packager-tool-v7h8s6yj.js → packager-tool-ewbkaecg.js} +18 -11
- package/dist/{packager-tool-d7v4083a.js → packager-tool-g08b669a.js} +22 -18
- package/dist/{packager-tool-m07vyk89.js → packager-tool-gb3dq79g.js} +36 -9
- package/dist/{packager-tool-395kmy70.js → packager-tool-gmbcn83x.js} +3 -3
- package/dist/{packager-tool-btz44ase.js → packager-tool-jhtsana2.js} +119 -52
- package/dist/{packager-tool-4rvfxkyh.js → packager-tool-jtg2arr8.js} +20 -8
- package/dist/{packager-tool-t39pjz7n.js → packager-tool-jtvhkavz.js} +48 -6
- package/dist/packager-tool-kffz64hn.js +279 -0
- package/dist/{packager-tool-p5322gew.js → packager-tool-kmwjscby.js} +88 -10
- package/dist/{packager-tool-ppj5f4y7.js → packager-tool-n1zrk6zv.js} +4 -2
- package/dist/{packager-tool-avrdp2za.js → packager-tool-pmc5txbm.js} +4 -6
- package/dist/{packager-tool-egc54x78.js → packager-tool-qhht1tc9.js} +2408 -771
- package/dist/{packager-tool-zcqfq3vc.js → packager-tool-qm876ezh.js} +84 -29
- package/dist/{packager-tool-resolver-30hxk8vm.js → packager-tool-resolver-y52kztnx.js} +6 -6
- package/dist/{packager-tool-3ejz0af8.js → packager-tool-rhg3mwkn.js} +14 -8
- package/dist/{packager-tool-ckrt4gyr.js → packager-tool-t9zked1m.js} +3 -3
- package/dist/{packager-tool-36w7az7k.js → packager-tool-tat0qs6z.js} +26 -10
- package/dist/packager-tool-tf0rn1tp.js +741 -0
- package/dist/{packager-tool-p5aar2k0.js → packager-tool-tmba5jv0.js} +140 -10
- package/dist/{packager-tool-vk3e239z.js → packager-tool-tqe3m1xp.js} +6 -6
- package/dist/{packager-tool-1ctvbx0h.js → packager-tool-tr3ttz5c.js} +1 -1
- package/dist/{packager-tool-k9dk39tg.js → packager-tool-txygqgb2.js} +3 -3
- package/dist/packager-tool-v6jcys3s.js +46 -0
- package/dist/packager-tool-w35s60sx.js +179 -0
- package/dist/{packager-tool-axqk17xw.js → packager-tool-xbfr6y2x.js} +142 -34
- package/dist/{packager-tool-2qsbh4kd.js → packager-tool-yfcscjfp.js} +50 -12
- package/dist/{packager-tool-ay4j9x92.js → packager-tool-ykq6gmhc.js} +19 -8
- package/dist/packager-tool.js +2 -2
- package/dist/prepare-solution-resources-sk3tyy8b.js +26 -0
- package/dist/{project-command-utils-82tja3k0.js → project-command-utils-7ygs8xq0.js} +20 -13
- package/dist/project-contributions-nzh06q0y.js +31 -0
- package/dist/project-identity-telemetry-47k2g7nq.js +18 -0
- package/dist/publish.js +14 -14
- package/dist/{resource-mutations-h6wfdqr4.js → resource-mutations-qcz2vcxe.js} +9 -9
- package/dist/{resource-version-lookup-xzgnvr48.js → resource-version-lookup-w3kzh4z9.js} +9 -9
- package/dist/resource.js +9 -9
- package/dist/{restore-command-service-wgqxp5tb.js → restore-command-service-m6c8fb7q.js} +20 -15
- package/dist/run-service-cmrzccnm.js +1055 -0
- package/dist/services/deploy-activate-service.d.ts +5 -2
- package/dist/services/deploy-config-file.d.ts +24 -0
- package/dist/services/deploy-delete-service.d.ts +1 -1
- package/dist/services/deploy-run-service.d.ts +8 -1
- package/dist/services/deploy-uninstall-service.d.ts +4 -2
- package/dist/services/deploy-upgrade-service.d.ts +23 -2
- package/dist/services/deployment-feed-locator.d.ts +19 -6
- package/dist/services/deployment-links.d.ts +16 -0
- package/dist/services/deployment-progress.d.ts +10 -0
- package/dist/services/deployment-search.d.ts +15 -2
- package/dist/services/deployment-state.d.ts +9 -0
- package/dist/services/feed-resolver.d.ts +17 -0
- package/dist/services/feed-selection.d.ts +59 -0
- package/dist/services/folder-runtime-check.d.ts +107 -0
- package/dist/services/incomplete-feed-sweep.d.ts +6 -0
- package/dist/services/pack-command-service.d.ts +6 -0
- package/dist/services/pack-project.d.ts +1 -1
- package/dist/services/package-metadata-rewrite.d.ts +13 -0
- package/dist/services/personal-workspace-resolver.d.ts +4 -1
- package/dist/services/prepare-solution-resources.d.ts +11 -6
- package/dist/services/project-contributions.d.ts +26 -2
- package/dist/services/project-identity-telemetry.d.ts +31 -0
- package/dist/services/solution-members.d.ts +31 -0
- package/dist/{ship-telemetry-19gx83af.js → ship-telemetry-9djqndmy.js} +4 -4
- package/dist/{solution-auth-jxcgd2m0.js → solution-auth-0e3qm74f.js} +3 -3
- package/dist/{solution-definition-helper-tqwd6cxn.js → solution-definition-helper-bkyhs1bd.js} +1 -1
- package/dist/{solution-identity-c23d9bfv.js → solution-identity-j63p6n81.js} +4 -4
- package/dist/templates/AGENTS.md +131 -24
- package/dist/tool.js +26 -26
- package/package.json +2 -2
- package/dist/deploy-delete-service-dwd4qb1m.js +0 -23
- package/dist/deploy-run-service-0kzfrvnn.js +0 -23
- package/dist/feed-resolver-w4y5aspe.js +0 -27
- package/dist/feed-scope-failure-4ef9zxcx.js +0 -20
- package/dist/pack-command-service-k7ebbfya.js +0 -29
- package/dist/packager-tool-vrqbbh01.js +0 -182
- package/dist/packager-tool-wwzg88qy.js +0 -74
- package/dist/prepare-solution-resources-h7zvnncd.js +0 -26
- package/dist/project-contributions-xx560n8y.js +0 -27
- package/dist/run-service-2rc4we5q.js +0 -506
|
@@ -1,10 +1,13 @@
|
|
|
1
1
|
import { type CliErrorCode, type RetryHint } from "@uipath/common";
|
|
2
|
+
import type { DeploymentLinks } from "./deployment-links";
|
|
2
3
|
import { type FeedSelectionFlags } from "./feed-selection";
|
|
3
4
|
export type ActivateDeploymentFailureReason = "auth_failed"
|
|
4
5
|
/** `--feed` named no feed this session can reach. */
|
|
5
6
|
| "feed_resolution_failed"
|
|
6
7
|
/** `--feed` / `--personal-workspace` with a session the server would not scope. */
|
|
7
8
|
| "feed_requires_user_session"
|
|
9
|
+
/** A key-shaped reference could not be read; not "not found" (UV-17910). */
|
|
10
|
+
| "lookup_failed"
|
|
8
11
|
/** Activation HTTP request failed (e.g. unknown deployment name). */
|
|
9
12
|
| "request_failed"
|
|
10
13
|
/** Activation poll didn't reach a terminal state — recommended exit 2 (CI distinguishability). */
|
|
@@ -28,7 +31,7 @@ export interface ActivateDeploymentOptions extends Pick<FeedSelectionFlags, "per
|
|
|
28
31
|
/** Host-side cancellation for the activation poll. */
|
|
29
32
|
signal?: AbortSignal;
|
|
30
33
|
}
|
|
31
|
-
export interface ActivateDeploymentSuccess {
|
|
34
|
+
export interface ActivateDeploymentSuccess extends DeploymentLinks {
|
|
32
35
|
ok: true;
|
|
33
36
|
/** `"SuccessfulActivate"` for terminal success, or `"Activation completed (no instance to poll)"` for the NoInstance short-circuit. */
|
|
34
37
|
status: string;
|
|
@@ -60,4 +63,4 @@ export type ActivateDeploymentResult = ActivateDeploymentSuccess | ActivateDeplo
|
|
|
60
63
|
* NoInstance, PollFailed, ActivationFailed, Success) to {@link ActivateDeploymentResult}.
|
|
61
64
|
* Does not touch `OutputFormatter`/`processContext`.
|
|
62
65
|
*/
|
|
63
|
-
export declare function activateDeploymentAsync(
|
|
66
|
+
export declare function activateDeploymentAsync(reference: string, options?: ActivateDeploymentOptions): Promise<ActivateDeploymentResult>;
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
import { type CliErrorCode, type RetryHint } from "@uipath/common";
|
|
2
|
+
/** Why a `--config-file` could not be used. */
|
|
3
|
+
export type DeployConfigFileFailureReason = "config_file_not_found" | "config_file_read_failed" | "config_file_parse_failed";
|
|
4
|
+
export type DeployConfigFileResult = {
|
|
5
|
+
ok: true;
|
|
6
|
+
/**
|
|
7
|
+
* The parsed file. The Pipelines install takes it as the request
|
|
8
|
+
* body as is: the SDK types `PackageConfigurationDto` as a string,
|
|
9
|
+
* so passing the object avoids a double stringify.
|
|
10
|
+
*/
|
|
11
|
+
body: unknown;
|
|
12
|
+
} | {
|
|
13
|
+
ok: false;
|
|
14
|
+
reason: DeployConfigFileFailureReason;
|
|
15
|
+
message: string;
|
|
16
|
+
instructions: string;
|
|
17
|
+
errorCode?: CliErrorCode;
|
|
18
|
+
retry?: RetryHint;
|
|
19
|
+
};
|
|
20
|
+
/**
|
|
21
|
+
* Reads the JSON or YAML deployment configuration that `deploy run` and
|
|
22
|
+
* `deploy upgrade` send as the Pipelines install body. Never throws.
|
|
23
|
+
*/
|
|
24
|
+
export declare function readDeployConfigFileAsync(configFile: string): Promise<DeployConfigFileResult>;
|
|
@@ -83,4 +83,4 @@ export type DeleteDeploymentResult = DeleteDeploymentSuccess | DeleteDeploymentF
|
|
|
83
83
|
*
|
|
84
84
|
* Does not touch `OutputFormatter`/`processContext`.
|
|
85
85
|
*/
|
|
86
|
-
export declare function deleteDeploymentAsync(
|
|
86
|
+
export declare function deleteDeploymentAsync(reference: string, options?: DeleteDeploymentOptions): Promise<DeleteDeploymentResult>;
|
|
@@ -1,4 +1,5 @@
|
|
|
1
1
|
import { type CliErrorCode, type RetryHint } from "@uipath/common";
|
|
2
|
+
import type { DeploymentLinks } from "./deployment-links";
|
|
2
3
|
import { type PendingResource } from "./deployment-state";
|
|
3
4
|
import { type FeedScope } from "./feed-resolver";
|
|
4
5
|
import { type PermanentDeletionResource } from "./permanent-deletion-consent";
|
|
@@ -107,7 +108,7 @@ export interface DeployOptions {
|
|
|
107
108
|
/** Host-side cancellation for both poll loops (e.g. VS Code's cancel button); replaces `processContext.pollSignal`. */
|
|
108
109
|
signal?: AbortSignal;
|
|
109
110
|
}
|
|
110
|
-
export interface DeploySuccess {
|
|
111
|
+
export interface DeploySuccess extends DeploymentLinks {
|
|
111
112
|
ok: true;
|
|
112
113
|
/** Terminal Pipelines status — `"DeploymentSucceeded"` on every path. */
|
|
113
114
|
status: string;
|
|
@@ -142,6 +143,12 @@ export interface DeploySuccess {
|
|
|
142
143
|
pendingResources?: PendingResource[];
|
|
143
144
|
/** What is left before the deployment runs. Absent when nothing is. */
|
|
144
145
|
nextSteps?: string[];
|
|
146
|
+
/**
|
|
147
|
+
* Runtimes the deployment's folder lacks for the package's processes, or
|
|
148
|
+
* that they could not be checked ({@link checkFolderRuntimesAsync}). Each
|
|
149
|
+
* is also logged as a warning. Absent when there is nothing to say.
|
|
150
|
+
*/
|
|
151
|
+
warnings?: string[];
|
|
145
152
|
/** Feed/PW only — the caller-chosen deployment name (`--name`). */
|
|
146
153
|
deploymentName?: string;
|
|
147
154
|
/** Feed/PW only — package name as deployed. */
|
|
@@ -4,7 +4,9 @@ export type UninstallDeploymentFailureReason = "auth_failed"
|
|
|
4
4
|
/** `--feed` named no feed this session can reach. */
|
|
5
5
|
| "feed_resolution_failed"
|
|
6
6
|
/** `--feed` / `--personal-workspace` with a session the server would not scope. */
|
|
7
|
-
| "feed_requires_user_session"
|
|
7
|
+
| "feed_requires_user_session"
|
|
8
|
+
/** A key-shaped reference could not be read; not "not found" (UV-17910). */
|
|
9
|
+
| "lookup_failed" | "uninstall_request_failed"
|
|
8
10
|
/**
|
|
9
11
|
* Orchestrator refused the uninstall because the deployment still had an
|
|
10
12
|
* operation running, and it was still running when the wait ran out —
|
|
@@ -81,4 +83,4 @@ export type UninstallDeploymentResult = UninstallDeploymentSuccess | UninstallDe
|
|
|
81
83
|
* usual failure taxonomy. `poll_timeout` → exit 2. Does not touch
|
|
82
84
|
* `OutputFormatter`/`processContext`.
|
|
83
85
|
*/
|
|
84
|
-
export declare function uninstallDeploymentAsync(
|
|
86
|
+
export declare function uninstallDeploymentAsync(reference: string, options?: UninstallDeploymentOptions): Promise<UninstallDeploymentResult>;
|
|
@@ -1,10 +1,14 @@
|
|
|
1
1
|
import type { CliErrorCode, PollFailureReason, RetryHint } from "@uipath/common";
|
|
2
2
|
import type { PipelineDeploymentStatus } from "@uipath/pipelines-sdk";
|
|
3
|
+
import { type DeployConfigFileFailureReason } from "./deploy-config-file";
|
|
4
|
+
import type { DeploymentLinks } from "./deployment-links";
|
|
3
5
|
import { type PendingResource } from "./deployment-state";
|
|
4
6
|
import { type PermanentDeletionResource } from "./permanent-deletion-consent";
|
|
5
7
|
export type UpgradeDeploymentFailureReason =
|
|
8
|
+
/** `--config-file` is missing, unreadable, or not JSON / YAML. Nothing was sent. */
|
|
9
|
+
DeployConfigFileFailureReason
|
|
6
10
|
/** Neither a deployment key nor a name+package pair was given, or both were. */
|
|
7
|
-
"invalid_target" | "auth_failed"
|
|
11
|
+
| "invalid_target" | "auth_failed"
|
|
8
12
|
/**
|
|
9
13
|
* No deployment to upgrade: the key form's lookup found none (unknown key,
|
|
10
14
|
* or a server without the lookup), or the name form's existence check
|
|
@@ -88,6 +92,16 @@ export interface UpgradeDeploymentOptions {
|
|
|
88
92
|
* is resolved and used.
|
|
89
93
|
*/
|
|
90
94
|
version?: string;
|
|
95
|
+
/**
|
|
96
|
+
* Path to a JSON or YAML deployment configuration (`deploy config get`,
|
|
97
|
+
* edited with `config set` / `config link`), sent as the install body —
|
|
98
|
+
* the same body `deploy run --config-file` sends. A resource the file
|
|
99
|
+
* names is applied as written; one it leaves out keeps the values the
|
|
100
|
+
* deployment has. With
|
|
101
|
+
* `version` set to the deployed version the run is a configuration
|
|
102
|
+
* change: how a live deployment's resources are relinked.
|
|
103
|
+
*/
|
|
104
|
+
configFile?: string;
|
|
91
105
|
/**
|
|
92
106
|
* Override the active tenant for auth resolution. The CLI's deprecated
|
|
93
107
|
* `--tenant` flag flows through here; library callers usually omit it.
|
|
@@ -147,7 +161,7 @@ export interface UpgradeDeploymentOptions {
|
|
|
147
161
|
*/
|
|
148
162
|
signal?: AbortSignal;
|
|
149
163
|
}
|
|
150
|
-
export interface UpgradeDeploymentSuccess {
|
|
164
|
+
export interface UpgradeDeploymentSuccess extends DeploymentLinks {
|
|
151
165
|
ok: true;
|
|
152
166
|
deploymentName: string;
|
|
153
167
|
/**
|
|
@@ -215,6 +229,13 @@ export interface UpgradeDeploymentSuccess {
|
|
|
215
229
|
pendingResources?: PendingResource[];
|
|
216
230
|
/** What is left before the new version runs; absent when it does. */
|
|
217
231
|
nextSteps?: string[];
|
|
232
|
+
/**
|
|
233
|
+
* Runtimes the deployment's folder lacks for the new version's processes,
|
|
234
|
+
* or that they could not be checked (`checkFolderRuntimesAsync`).
|
|
235
|
+
* Each is also logged as a warning. Absent when there is nothing to say,
|
|
236
|
+
* and with `noWait`.
|
|
237
|
+
*/
|
|
238
|
+
warnings?: string[];
|
|
218
239
|
/**
|
|
219
240
|
* The installed resources acknowledged for permanent deletion before the
|
|
220
241
|
* install that succeeded (`kind 'name'`). Absent when none were.
|
|
@@ -33,19 +33,32 @@ export interface DeploymentSweep {
|
|
|
33
33
|
/** True when no feed was skipped. */
|
|
34
34
|
complete: boolean;
|
|
35
35
|
}
|
|
36
|
+
/** See {@link DeploymentLocationOptions.uninstalled}. */
|
|
37
|
+
export type UninstalledRecords = "skip" | "accept" | "fallback";
|
|
36
38
|
/** Auth-resolution knobs the feed sweep forwards to its lookups. */
|
|
37
39
|
export interface DeploymentLocationOptions {
|
|
38
40
|
tenant?: string;
|
|
39
41
|
loginValidity?: number;
|
|
40
42
|
envFilePath?: string;
|
|
41
43
|
/**
|
|
42
|
-
*
|
|
43
|
-
*
|
|
44
|
-
*
|
|
45
|
-
*
|
|
46
|
-
*
|
|
44
|
+
* What a name whose newest row records a completed uninstall resolves to.
|
|
45
|
+
*
|
|
46
|
+
* - `skip` (the default): nothing — the sweep moves on. `activate` and
|
|
47
|
+
* `uninstall` act on a live deployment, so a name uninstalled on the
|
|
48
|
+
* tenant and redeployed into a feed resolves to the feed rather than to
|
|
49
|
+
* the tenant's history row.
|
|
50
|
+
* - `accept`: that row, like a live one. `deploy delete` exists to remove
|
|
51
|
+
* exactly those records (UV-16671).
|
|
52
|
+
* - `fallback`: the first such row, only when no feed that answered holds
|
|
53
|
+
* a live deployment of the name. `deploy status` reports what `deploy
|
|
54
|
+
* list` shows (cli#5590) without letting a history row hide a live
|
|
55
|
+
* deployment in a later feed. A feed that could not be searched may
|
|
56
|
+
* still hold one, so the row comes back with `complete: false` and the
|
|
57
|
+
* caller decides: an external app that cannot list feeds skips every
|
|
58
|
+
* non-tenant feed, and would otherwise never see the record, while an
|
|
59
|
+
* outage clears on a retry.
|
|
47
60
|
*/
|
|
48
|
-
|
|
61
|
+
uninstalled?: UninstalledRecords;
|
|
49
62
|
/**
|
|
50
63
|
* The feed the caller named (`--feed` / `--personal-workspace`, or the
|
|
51
64
|
* feed a generated follow-up command carried forward). Only that feed is
|
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
import type { InitOverrideFunction } from "@uipath/solution-sdk";
|
|
2
|
+
import type { SolutionAuthContext } from "@uipath/solution-sdk/auth";
|
|
3
|
+
export interface DeploymentLinks {
|
|
4
|
+
orchestratorUrl?: string;
|
|
5
|
+
folderUrl?: string;
|
|
6
|
+
}
|
|
7
|
+
/** Browser routes verified in Orchestrator's tenant-main/sidepanel routes,
|
|
8
|
+
* topology's _openSolutionPanel, and FolderKeyParamGuard (SOL-7446).
|
|
9
|
+
* automationsolutions_ is the API/remote-module service, not the browser route.
|
|
10
|
+
*/
|
|
11
|
+
export declare function buildDeploymentLinks(auth: Pick<SolutionAuthContext, "baseUrl" | "organizationName" | "tenantName">, deploymentKey?: string | null, installedFolderKey?: string | null, feedFolderKey?: string | null): DeploymentLinks;
|
|
12
|
+
/** Enrichment is best-effort: a missing folder or an unreadable record must
|
|
13
|
+
* never turn an installed deployment into a failed command. Read the exact
|
|
14
|
+
* generation, never a possibly older same-name search row.
|
|
15
|
+
*/
|
|
16
|
+
export declare function readDeploymentLinksAsync(auth: SolutionAuthContext, deploymentKey: string | undefined, scope?: InitOverrideFunction, feedFolderKey?: string, signal?: AbortSignal): Promise<DeploymentLinks>;
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
import type { DeploymentRunStatus, PipelineDeploymentResult } from "@uipath/pipelines-sdk";
|
|
2
|
+
/** Only fields actually carried by the status read; no extra requests for progress. */
|
|
3
|
+
export declare function deploymentProgressStatus(result: Pick<DeploymentRunStatus, "status" | "operation" | "operationStatus" | "activationStatus">): string;
|
|
4
|
+
export declare function pipelineProgressStatus(result: PipelineDeploymentResult): string;
|
|
5
|
+
/**
|
|
6
|
+
* One reporter per wait. Plain lines on TTYs as well as pipes keep redirected
|
|
7
|
+
* stderr readable and require no terminal cursor cleanup on any poll outcome.
|
|
8
|
+
* pollUntil supplies elapsed time, so no timer can outlive the wait.
|
|
9
|
+
*/
|
|
10
|
+
export declare function createDeploymentProgress(label: string): (status: string, elapsedMs: number) => void;
|
|
@@ -7,6 +7,14 @@ export { httpStatusOf } from "./http-status";
|
|
|
7
7
|
/** A deployment read by key: the fields the callers act on, from either route. */
|
|
8
8
|
export interface DeploymentByKey {
|
|
9
9
|
deploymentKey: string;
|
|
10
|
+
/** The deployment's name: what the name-addressed routes take. */
|
|
11
|
+
deploymentName: string;
|
|
12
|
+
/**
|
|
13
|
+
* The feed the record lives in, `null` for the tenant feed. Only the
|
|
14
|
+
* Pipelines lookup says (it spans every feed); the Solutions read answers
|
|
15
|
+
* in the feed it was sent to, so it leaves this undefined.
|
|
16
|
+
*/
|
|
17
|
+
locationKey?: string | null;
|
|
10
18
|
operationStatus: DeploymentOperationStatus;
|
|
11
19
|
installedRootFolderKey?: string | null;
|
|
12
20
|
/**
|
|
@@ -28,6 +36,8 @@ export interface ReadDeploymentByKeyOptions {
|
|
|
28
36
|
* interval.
|
|
29
37
|
*/
|
|
30
38
|
solutionsOnly?: boolean;
|
|
39
|
+
/** Aborts the reads. */
|
|
40
|
+
signal?: AbortSignal;
|
|
31
41
|
}
|
|
32
42
|
/**
|
|
33
43
|
* Read a deployment by key once a caller holds one, instead of searching its
|
|
@@ -58,7 +68,7 @@ export declare function readDeploymentByKeyAsync(auth: SolutionAuthContext, depl
|
|
|
58
68
|
* header), and it returns the exact row asked for rather than the current
|
|
59
69
|
* generation. A 404 is `undefined`; any other failure throws.
|
|
60
70
|
*/
|
|
61
|
-
export declare function readDeploymentByKeyViaSolutionsAsync(auth: SolutionAuthContext, deploymentKey: string, scope?: InitOverrideFunction): Promise<DeploymentByKey | undefined>;
|
|
71
|
+
export declare function readDeploymentByKeyViaSolutionsAsync(auth: SolutionAuthContext, deploymentKey: string, scope?: InitOverrideFunction, signal?: AbortSignal): Promise<DeploymentByKey | undefined>;
|
|
62
72
|
/**
|
|
63
73
|
* Look up a deployment by name in the persistent search/list service.
|
|
64
74
|
* Returns the deployment's **current generation** — every upgrade and
|
|
@@ -84,7 +94,10 @@ export declare function findDeploymentByName(auth: SolutionAuthContext, deployme
|
|
|
84
94
|
*/
|
|
85
95
|
export declare function findLiveDeploymentByName(auth: SolutionAuthContext, deploymentName: string, scope?: InitOverrideFunction): Promise<DeploymentSearchItemDto2 | undefined>;
|
|
86
96
|
/** A row recording an uninstall that finished: the deployment is gone. */
|
|
87
|
-
export declare function isCompletedUninstall(row:
|
|
97
|
+
export declare function isCompletedUninstall(row: {
|
|
98
|
+
operation?: string | null;
|
|
99
|
+
operationStatus?: string | null;
|
|
100
|
+
} | undefined): boolean;
|
|
88
101
|
/**
|
|
89
102
|
* Every deployment whose `packageName` matches exactly.
|
|
90
103
|
*
|
|
@@ -67,6 +67,15 @@ export interface DeploymentStateRecord {
|
|
|
67
67
|
activationStatus?: string | null;
|
|
68
68
|
packageVersion?: string | null;
|
|
69
69
|
currentPackageVersion?: string | null;
|
|
70
|
+
/**
|
|
71
|
+
* Optional; when known, the relink steps name the deployment by key —
|
|
72
|
+
* `deploy upgrade <key>` reads the package and feed off it.
|
|
73
|
+
*/
|
|
74
|
+
key?: string | null;
|
|
75
|
+
/** Stable across upgrades; preferred over `key` in the steps. */
|
|
76
|
+
installDeploymentKey?: string | null;
|
|
77
|
+
/** Optional; names the package in the `config get` step. */
|
|
78
|
+
packageName?: string | null;
|
|
70
79
|
}
|
|
71
80
|
export { quoteForShell };
|
|
72
81
|
/**
|
|
@@ -31,6 +31,23 @@ export declare function feedScopeInitOverride(scope: FeedScope): InitOverrideFun
|
|
|
31
31
|
* Leading space included, so callers append it to a command verbatim.
|
|
32
32
|
*/
|
|
33
33
|
export declare function feedSelectorFlag(scope: Pick<FeedScope, "kind" | "folderKey"> | undefined): string;
|
|
34
|
+
/**
|
|
35
|
+
* ` --tenant '<t>'` when the caller overrode the tenant, so a copied retry
|
|
36
|
+
* command targets the same tenant. Leading space included, like
|
|
37
|
+
* {@link feedSelectorFlag}.
|
|
38
|
+
*/
|
|
39
|
+
export declare function tenantFlag(options: {
|
|
40
|
+
tenant?: string;
|
|
41
|
+
}): string;
|
|
42
|
+
/**
|
|
43
|
+
* The `deploy delete` a refusal prints for a deployment record — the exit
|
|
44
|
+
* for a first install's pending draft, which offers `Delete` and has no live
|
|
45
|
+
* version for `deploy upgrade --discard-draft` to fall back to (STUD-81933).
|
|
46
|
+
* `feedFlag` is the selector as {@link feedSelectorFlag} prints it.
|
|
47
|
+
*/
|
|
48
|
+
export declare function deleteDeploymentCommand(deploymentName: string, feedFlag: string, options: {
|
|
49
|
+
tenant?: string;
|
|
50
|
+
}): string;
|
|
34
51
|
export interface ResolveFeedScopeOptions {
|
|
35
52
|
/** Target the caller's own Personal Workspace feed. */
|
|
36
53
|
personalWorkspace?: boolean;
|
|
@@ -48,3 +48,62 @@ export type FeedSelection =
|
|
|
48
48
|
* @param action what the command does, e.g. "Uninstalling a deployment"
|
|
49
49
|
*/
|
|
50
50
|
export declare function resolveFeedSelectionAsync(auth: Pick<SolutionAuthContext, "accessToken" | "identity" | "basePath">, flags: FeedSelectionFlags, action: string): Promise<FeedSelection>;
|
|
51
|
+
/**
|
|
52
|
+
* "No deployment named 'x' was found", or, for a GUID that matched neither a
|
|
53
|
+
* key nor a name, a text that says both were tried.
|
|
54
|
+
*/
|
|
55
|
+
export declare function missingDeploymentMessage(reference: string): string;
|
|
56
|
+
export type DeploymentTarget = {
|
|
57
|
+
ok: true;
|
|
58
|
+
/** The name the lookup and the name-addressed routes take. */
|
|
59
|
+
deploymentName: string;
|
|
60
|
+
/** As {@link FeedSelection}: undefined means sweep the feeds. */
|
|
61
|
+
selectedFeed?: FeedScope;
|
|
62
|
+
/**
|
|
63
|
+
* The key of the record a key resolved to; undefined for a name.
|
|
64
|
+
* Its presence proves the deployment exists, so a later refusal is
|
|
65
|
+
* never "not found".
|
|
66
|
+
*/
|
|
67
|
+
deploymentKey?: string;
|
|
68
|
+
/**
|
|
69
|
+
* The deployment's current-generation key, when the Pipelines
|
|
70
|
+
* lookup said so. The deprecated Solutions read returns the exact
|
|
71
|
+
* row asked for, which may be superseded, so it leaves this
|
|
72
|
+
* undefined: there the name's current record is the answer.
|
|
73
|
+
*/
|
|
74
|
+
currentKey?: string;
|
|
75
|
+
} | Extract<FeedSelection, {
|
|
76
|
+
ok: false;
|
|
77
|
+
}> | {
|
|
78
|
+
ok: false;
|
|
79
|
+
/** The key could not be read: not "not found", so no name fallback. */
|
|
80
|
+
reason: "lookup_failed";
|
|
81
|
+
message: string;
|
|
82
|
+
instructions: string;
|
|
83
|
+
errorCode?: CliErrorCode;
|
|
84
|
+
retry?: RetryHint;
|
|
85
|
+
};
|
|
86
|
+
/**
|
|
87
|
+
* The deployment `uninstall`, `activate` and `delete` act on, from what the
|
|
88
|
+
* caller typed: a name, or the key `deploy list` prints (UV-17910). Names come
|
|
89
|
+
* first (TOOL_SPEC Rule 10); a key is the alternative form.
|
|
90
|
+
*
|
|
91
|
+
* The flags are resolved first ({@link resolveFeedSelectionAsync}). A
|
|
92
|
+
* GUID is then read as a key ({@link readDeploymentByKeyAsync}), and the answer
|
|
93
|
+
* gives the deployment's name and feed, so the name path that follows reads
|
|
94
|
+
* that one feed and the name-addressed routes get a name. The Pipelines
|
|
95
|
+
* lookup spans every feed, so its feed replaces the flags' — the record says
|
|
96
|
+
* where it lives, as for `deploy status` — and is held to the same
|
|
97
|
+
* fail-closed session rule as a `--feed`. The deprecated Solutions read
|
|
98
|
+
* answers in the feed it was sent to — the flags', or the tenant without
|
|
99
|
+
* one — and that feed is kept. A superseded key
|
|
100
|
+
* answers with the deployment's current record, so the command acts on the
|
|
101
|
+
* deployment the key belongs to.
|
|
102
|
+
*
|
|
103
|
+
* A GUID that matches no key is looked up as a name, since names accept any
|
|
104
|
+
* string. A key read that fails for another reason is the answer: falling
|
|
105
|
+
* back to a name would report "not found" for a deployment that exists.
|
|
106
|
+
*
|
|
107
|
+
* @param action what the command does, e.g. "Uninstalling a deployment"
|
|
108
|
+
*/
|
|
109
|
+
export declare function resolveDeploymentTargetAsync(auth: SolutionAuthContext, reference: string, flags: FeedSelectionFlags, action: string): Promise<DeploymentTarget>;
|
|
@@ -0,0 +1,107 @@
|
|
|
1
|
+
import { type MachineRuntimeDto, type ProcessType, type RuntimeType } from "@uipath/orchestrator-sdk";
|
|
2
|
+
import { type PackageVersionResourceDto } from "@uipath/pipelines-sdk";
|
|
3
|
+
import { type InitOverrideFunction } from "@uipath/solution-sdk";
|
|
4
|
+
import type { SolutionAuthContext } from "@uipath/solution-sdk/auth";
|
|
5
|
+
/** A process of the package whose jobs need a runtime in the folder. */
|
|
6
|
+
export interface FolderBoundProcess {
|
|
7
|
+
name: string;
|
|
8
|
+
processType: ProcessType;
|
|
9
|
+
runtimeTypes: readonly RuntimeType[];
|
|
10
|
+
}
|
|
11
|
+
/**
|
|
12
|
+
* Which of the deployment's processes are linked to an existing process: the
|
|
13
|
+
* names (lowercased), or why the list is not known — `session` when this
|
|
14
|
+
* login cannot read it at all (an external app), `failed` when the read did.
|
|
15
|
+
*/
|
|
16
|
+
export type LinkedProcesses = {
|
|
17
|
+
names: ReadonlySet<string>;
|
|
18
|
+
} | {
|
|
19
|
+
unknown: "session" | "failed";
|
|
20
|
+
};
|
|
21
|
+
/** The reads the check makes, so a test can stand in for the servers. */
|
|
22
|
+
export interface FolderRuntimeReads {
|
|
23
|
+
/** The package's resources, from the Pipelines package-version read. */
|
|
24
|
+
packageResources(signal: AbortSignal): Promise<PackageVersionResourceDto[]>;
|
|
25
|
+
linkedProcesses(signal: AbortSignal): Promise<LinkedProcesses>;
|
|
26
|
+
/** Whether the deployment's feed is the caller's Personal Workspace. */
|
|
27
|
+
inPersonalWorkspace(signal: AbortSignal): Promise<boolean>;
|
|
28
|
+
/** The folder's numeric id and path, or undefined when not found. */
|
|
29
|
+
folder(signal: AbortSignal): Promise<{
|
|
30
|
+
id: number;
|
|
31
|
+
path: string;
|
|
32
|
+
} | undefined>;
|
|
33
|
+
runtimes(folderId: number, processType: ProcessType, signal: AbortSignal): Promise<MachineRuntimeDto[]>;
|
|
34
|
+
}
|
|
35
|
+
export interface FolderRuntimeCheckOptions {
|
|
36
|
+
auth: SolutionAuthContext;
|
|
37
|
+
packageName: string;
|
|
38
|
+
packageVersion: string;
|
|
39
|
+
/** The deploy's feed scope, so the package is read from its own feed. */
|
|
40
|
+
scope: InitOverrideFunction | undefined;
|
|
41
|
+
/**
|
|
42
|
+
* The deployment record whose root folder is checked: its
|
|
43
|
+
* `installedRootFolderKey` names the folder, whatever Orchestrator renamed
|
|
44
|
+
* it to. When the record cannot be read, `folderPath` is looked up.
|
|
45
|
+
*/
|
|
46
|
+
deploymentKey?: string | null;
|
|
47
|
+
folderPath?: string;
|
|
48
|
+
/**
|
|
49
|
+
* Processes the deploy's own `--config-file` links to an existing
|
|
50
|
+
* resource ({@link linkedProcessNamesFromConfig}). They are left out
|
|
51
|
+
* even when the deployment's resources cannot be read, but the list is
|
|
52
|
+
* never taken as complete: a retry onto a draft keeps links the file
|
|
53
|
+
* does not name.
|
|
54
|
+
*/
|
|
55
|
+
configuredLinks?: readonly string[];
|
|
56
|
+
/**
|
|
57
|
+
* Whether the deployment lives in the caller's Personal Workspace. Left
|
|
58
|
+
* undefined, it is read: the deployment's feed (`feedKey`) compared with
|
|
59
|
+
* the caller's own workspace.
|
|
60
|
+
*/
|
|
61
|
+
personalWorkspace?: boolean;
|
|
62
|
+
feedKey?: string;
|
|
63
|
+
tenant?: string;
|
|
64
|
+
loginValidity?: number;
|
|
65
|
+
envFilePath?: string;
|
|
66
|
+
/** The deploy's own cancellation (Ctrl-C); the check stops with it. */
|
|
67
|
+
signal?: AbortSignal;
|
|
68
|
+
/** Overrides {@link CHECK_DEADLINE_MS}; for tests. */
|
|
69
|
+
deadlineMs?: number;
|
|
70
|
+
}
|
|
71
|
+
/**
|
|
72
|
+
* The process names a deploy config file links to an existing resource
|
|
73
|
+
* (`deploy config link` writes `linkToResource`). A linked process is not
|
|
74
|
+
* installed in the deployment's folder: its jobs run where the linked one
|
|
75
|
+
* lives, so the folder check leaves it out.
|
|
76
|
+
*/
|
|
77
|
+
export declare function linkedProcessNamesFromConfig(config: unknown): string[];
|
|
78
|
+
/**
|
|
79
|
+
* The processes of a package whose jobs need a runtime assigned to the
|
|
80
|
+
* folder. The process resource's `type` is the solution spelling of
|
|
81
|
+
* Orchestrator's process type (`process`, `testAutomationProcess`,
|
|
82
|
+
* `mcpserver`, …); the resource-builder maps it back, and Orchestrator's own
|
|
83
|
+
* enum decides whether it is one. A type it does not know is skipped, never
|
|
84
|
+
* guessed at, and so is one that needs nothing in the folder.
|
|
85
|
+
*/
|
|
86
|
+
export declare function folderBoundProcesses(resources: readonly PackageVersionResourceDto[], options?: {
|
|
87
|
+
personalWorkspace?: boolean;
|
|
88
|
+
}): FolderBoundProcess[];
|
|
89
|
+
/**
|
|
90
|
+
* One warning per process that has no usable runtime in the folder. `runtimes`
|
|
91
|
+
* holds the folder's rows per process type, as `GetRuntimesForFolder` answered.
|
|
92
|
+
*/
|
|
93
|
+
export declare function missingRuntimeWarnings(processes: readonly FolderBoundProcess[], folderPath: string, runtimes: ReadonlyMap<ProcessType, readonly MachineRuntimeDto[]>, options?: {
|
|
94
|
+
tenant?: string;
|
|
95
|
+
mayBeLinked?: boolean;
|
|
96
|
+
}): string[];
|
|
97
|
+
/**
|
|
98
|
+
* Whether the deployment's folder can run the package's processes, as
|
|
99
|
+
* warnings: one per process with no runtime there, or one saying the check
|
|
100
|
+
* could not run. Never throws, never fails the deploy, and gives up after
|
|
101
|
+
* {@link CHECK_DEADLINE_MS} (or with the deploy's own signal): the install
|
|
102
|
+
* has landed by the time this runs, and a missing runtime is the caller's to
|
|
103
|
+
* fix. Reads nothing past the package when no process needs a folder runtime.
|
|
104
|
+
*/
|
|
105
|
+
export declare function checkFolderRuntimesAsync(options: FolderRuntimeCheckOptions, reads?: FolderRuntimeReads): Promise<string[]>;
|
|
106
|
+
/** Prints each warning on stderr, and returns them for `Data.Warnings`. */
|
|
107
|
+
export declare function logFolderRuntimeWarnings(warnings: string[]): string[];
|
|
@@ -54,6 +54,12 @@ export interface IncompleteSweepReport {
|
|
|
54
54
|
export declare function isNameOrFeedRefusal(errorCode: CliErrorCode, httpStatus: number | undefined): boolean;
|
|
55
55
|
/** The sentence every verb opens its instructions with; each adds its own way out. */
|
|
56
56
|
export declare const INCOMPLETE_SWEEP_ADVICE = "The deployment may be in a feed that was not searched.";
|
|
57
|
+
/**
|
|
58
|
+
* The next step for an uninstalled record found while some feeds could not
|
|
59
|
+
* be searched (`deploy status`, cli#5590): one of them may hold a live
|
|
60
|
+
* deployment of the same name.
|
|
61
|
+
*/
|
|
62
|
+
export declare function unsearchedFeedsNextStep(skipped: readonly SkippedFeed[]): string;
|
|
57
63
|
/**
|
|
58
64
|
* What the user can do about a failure of this class. The retry case names
|
|
59
65
|
* the service to wait for; the others do not depend on it.
|
|
@@ -49,6 +49,12 @@ export declare class PackCommandService {
|
|
|
49
49
|
* The copy keeps the source's basename: `createPackOptions` derives the
|
|
50
50
|
* package name from the user-supplied path, but member-project and
|
|
51
51
|
* `.uipx` lookups walk the copied tree, so the two must agree.
|
|
52
|
+
*
|
|
53
|
+
* `node_modules/` stays behind. The copy follows symlinks and drops file
|
|
54
|
+
* modes, so `node_modules/.bin/*` would arrive as plain, non-executable
|
|
55
|
+
* files and a coded app's build in the copy would fail where the real pack
|
|
56
|
+
* succeeds. Without it the copy installs from scratch; no packer reads
|
|
57
|
+
* `node_modules` otherwise.
|
|
52
58
|
*/
|
|
53
59
|
private copyDirectoryForDryRun;
|
|
54
60
|
/**
|
|
@@ -16,7 +16,7 @@ export interface SolutionProjectToPack {
|
|
|
16
16
|
* the project — the one the solution saved, else
|
|
17
17
|
* `<solution>.<short type>.<project folder>` — sanitized as the packager will.
|
|
18
18
|
*/
|
|
19
|
-
export declare function prepareSolutionProjectAsync(fs: IFileSystem, solutionDir: string, selector: string, packageIdOverride: string | undefined): Promise<SolutionProjectToPack>;
|
|
19
|
+
export declare function prepareSolutionProjectAsync(fs: IFileSystem, solutionDir: string, selector: string, packageIdOverride: string | undefined, forDebug?: boolean): Promise<SolutionProjectToPack>;
|
|
20
20
|
/**
|
|
21
21
|
* Pack a project {@link prepareSolutionProjectAsync} prepared. A failure keeps
|
|
22
22
|
* the per-project findings a whole-solution pack reports, in
|
|
@@ -16,6 +16,19 @@ export interface PackageMetadataRewriteResult {
|
|
|
16
16
|
/** Freshly minted `spec.packageVersionKey` — see the note in `rewritePackageMetadata`. */
|
|
17
17
|
packageVersionKey: string;
|
|
18
18
|
}
|
|
19
|
+
/**
|
|
20
|
+
* The ID of the solution a packed `.zip` was built from, or `undefined` when
|
|
21
|
+
* the archive does not carry one that reads as a GUID. Never throws.
|
|
22
|
+
*
|
|
23
|
+
* The resource builder writes the `.uipx` `SolutionId` into the archive-root
|
|
24
|
+
* `solutionMetadata.json` as `spec.projectKey` (the same field `publish`
|
|
25
|
+
* telemetry reads). A solution built in Studio Web, or uploaded there with
|
|
26
|
+
* `solution upload`, carries its Studio Web ID in the `.uipx`, so this is the
|
|
27
|
+
* ID `solution download` exports — the link from a deployed package back to
|
|
28
|
+
* its source (UV-16644). A solution only ever packed locally carries an ID
|
|
29
|
+
* Studio Web does not know, so a caller must not promise the export succeeds.
|
|
30
|
+
*/
|
|
31
|
+
export declare function readPackedSolutionId(archive: Uint8Array): string | undefined;
|
|
19
32
|
/**
|
|
20
33
|
* Re-stamp the solution package identity of an already-packed `.zip` and return
|
|
21
34
|
* the rewritten archive. Backs `solution publish --package-name/--package-version`,
|
|
@@ -25,4 +25,7 @@ export interface ResolvedPersonalWorkspace {
|
|
|
25
25
|
* @param options - tenant and login validity for API authentication
|
|
26
26
|
* @returns Resolved Personal Workspace `{ key, name }`
|
|
27
27
|
*/
|
|
28
|
-
export declare function resolvePersonalWorkspace(options?: Pick<CreateApiClientOptions, "tenant" | "loginValidity" | "envFilePath">
|
|
28
|
+
export declare function resolvePersonalWorkspace(options?: Pick<CreateApiClientOptions, "tenant" | "loginValidity" | "envFilePath"> & {
|
|
29
|
+
/** Aborts the read. */
|
|
30
|
+
signal?: AbortSignal;
|
|
31
|
+
}): Promise<ResolvedPersonalWorkspace>;
|
|
@@ -35,25 +35,30 @@ export declare function selfProvisionedFrom(contributions: ProjectContributions)
|
|
|
35
35
|
*
|
|
36
36
|
* The order is load-bearing:
|
|
37
37
|
*
|
|
38
|
-
* 1. `ensurePackagerTools` — the
|
|
39
|
-
* 2.
|
|
38
|
+
* 1. `ensurePackagerTools` — the dispatches go to registered factories.
|
|
39
|
+
* 2. prepare — the one round in which a project's own tool may WRITE the
|
|
40
|
+
* resource files it owns, so the collect, the sync and the
|
|
41
|
+
* runtime-dependency emission all observe one prepared state. Gated like
|
|
42
|
+
* the collect: a preparation problem fails before anything else runs.
|
|
43
|
+
* 3. collect — reads project files only, which the sync never touches, so
|
|
40
44
|
* collecting before and applying after cannot see two different states.
|
|
41
|
-
*
|
|
45
|
+
* 4. gate (pack, upload) — a project reporting a problem with its own files
|
|
42
46
|
* must fail before any write, not leave half-synced resources behind.
|
|
43
|
-
*
|
|
47
|
+
* 5. sync — carries the contributed subTypes, which is what lets reconcile
|
|
44
48
|
* generate (or repair) artefact resources for a type whose template row is
|
|
45
49
|
* keyed `<type>_<subType>`, and the contributed bindings of a type that
|
|
46
50
|
* keeps them in its own source format (a Flow's `.flow`), and the
|
|
47
51
|
* name-targeted patches' resources, which it mints without asking the
|
|
48
52
|
* Resource Catalog.
|
|
49
|
-
*
|
|
53
|
+
* 6. apply — after the sync, because the sync can create the app resource a
|
|
50
54
|
* patch targets. An unmatched patch here is a contributor bug, not a race,
|
|
51
55
|
* which is why gating callers also fail on one.
|
|
52
|
-
*
|
|
56
|
+
* 7. runtime dependencies — mirrors Orchestrator BE's
|
|
53
57
|
* `ProcessesExportHandlerBase.GetRuntimeDependenciesAsync`. It gets the
|
|
54
58
|
* same contributed bindings the sync used, so a project whose source is
|
|
55
59
|
* not its `bindings_v2.json` cannot have the two stages disagree.
|
|
56
60
|
*/
|
|
57
61
|
export declare function prepareSolutionResources(solutionDir: string, fs: IFileSystem, options?: {
|
|
58
62
|
gate?: boolean;
|
|
63
|
+
forDebug?: boolean;
|
|
59
64
|
}): Promise<PrepareResult>;
|
|
@@ -35,9 +35,33 @@ export declare class ProjectContributionsError extends Error {
|
|
|
35
35
|
* before the sync and applying after it cannot see two different states.
|
|
36
36
|
*
|
|
37
37
|
* `onlyProjectId` restricts the walk to one `.uipx` project `Id` — the one a
|
|
38
|
-
* `pack --project` run packs.
|
|
38
|
+
* `pack --project` run packs. `forDebug` marks a pack for a debug run,
|
|
39
|
+
* passed to each contributor.
|
|
39
40
|
*/
|
|
40
|
-
export declare function collectProjectContributions(solutionDir: string, fs?: IFileSystem, onlyProjectId?:
|
|
41
|
+
export declare function collectProjectContributions(solutionDir: string, fs?: IFileSystem, { onlyProjectId, forDebug, }?: {
|
|
42
|
+
onlyProjectId?: string;
|
|
43
|
+
forDebug?: boolean;
|
|
44
|
+
}): Promise<ProjectContributions>;
|
|
45
|
+
export interface ProjectPreparations {
|
|
46
|
+
/** Blocking problems, deduplicated. Gating callers throw on any entry. */
|
|
47
|
+
errors: ProjectContributionError[];
|
|
48
|
+
}
|
|
49
|
+
/**
|
|
50
|
+
* Walk the `.uipx` and let each project's registered tool factory bring the
|
|
51
|
+
* files it owns up to date, before anything reads them. The one write round of
|
|
52
|
+
* the pipeline: it runs before `collectProjectContributions`, so contributions,
|
|
53
|
+
* the sync and the runtime-dependency emission all observe one prepared state.
|
|
54
|
+
*
|
|
55
|
+
* A factory without the method simply has nothing to prepare — tool bundles
|
|
56
|
+
* version independently of the host, and unlike `describeResourcesAsync` no
|
|
57
|
+
* project type's resources exist ONLY through preparation, so absence never
|
|
58
|
+
* needs reporting.
|
|
59
|
+
*
|
|
60
|
+
* Findings are deduplicated: a solution-wide problem (two projects' nodes
|
|
61
|
+
* claiming one resource) is found from each involved project and reported
|
|
62
|
+
* identically by each.
|
|
63
|
+
*/
|
|
64
|
+
export declare function prepareProjectResources(solutionDir: string, fs?: IFileSystem): Promise<ProjectPreparations>;
|
|
41
65
|
/** Throws once with every collected error. Pack's gate. */
|
|
42
66
|
export declare function assertNoContributionErrors(contributions: ProjectContributions): void;
|
|
43
67
|
/**
|