@unotest/protocol 0.46.0 → 0.48.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/CHANGELOG.md +41 -0
- package/dist/index.d.ts +515 -258
- package/dist/index.js +1 -1
- package/package.json +1 -1
package/dist/index.d.ts
CHANGED
|
@@ -222,6 +222,11 @@ declare function makeRunId(name: string): string;
|
|
|
222
222
|
* to a literal `run` segment — uniqueness still comes from the ts +
|
|
223
223
|
* random suffix appended by `makeRunId`. */
|
|
224
224
|
declare function sanitizeRunIdSegment(name: string): string;
|
|
225
|
+
/** Whether `value` has the shape {@link makeRunId} gives — one directory
|
|
226
|
+
* name, nothing that could climb out of a runs root. For an id read from
|
|
227
|
+
* somewhere a suite writes (a collection's journal names its scenarios'
|
|
228
|
+
* runs) before it is ever joined into a path. */
|
|
229
|
+
declare function isRunId(value: string): boolean;
|
|
225
230
|
|
|
226
231
|
/** Epoch millis encoded in a runId, or null when the id does not follow
|
|
227
232
|
* `makeRunId`'s shape. Callers must handle null rather than guess — an
|
|
@@ -990,10 +995,314 @@ declare function scenarioIndexFileName(ref: string): string;
|
|
|
990
995
|
/** Inverse of `scenarioIndexFileName`. */
|
|
991
996
|
declare function scenarioRefFromFileName(fileName: string): string | null;
|
|
992
997
|
|
|
998
|
+
declare const BOX_RUNS_SEGMENT = "runs";
|
|
999
|
+
/** Set by the guard, forwarded by the viewer verbatim, verified by the
|
|
1000
|
+
* daemon: WHO clicked, in a form the thing in between cannot write.
|
|
1001
|
+
* Named here because three packages have to spell it identically and
|
|
1002
|
+
* this is the one they all already depend on — the signing and the
|
|
1003
|
+
* verification live on the box side (`@unotest/box-kit`), which is
|
|
1004
|
+
* where the secret is. */
|
|
1005
|
+
declare const ACTOR_TICKET_HEADER = "x-unotest-actor-ticket";
|
|
1006
|
+
/** Set by the guard on its own requests to the daemon. The daemon reads
|
|
1007
|
+
* the actor label only next to a valid one. */
|
|
1008
|
+
declare const GUARD_SECRET_HEADER = "x-unotest-guard-secret";
|
|
1009
|
+
/** `/api/box/envs/<project>/<env>/runs`. */
|
|
1010
|
+
declare function boxRunsPath(project: string, environment: string): string;
|
|
1011
|
+
/** `/api/box/envs/<project>/<env>/runs/<runId>`. */
|
|
1012
|
+
declare function boxRunPath(project: string, environment: string, runId: string): string;
|
|
1013
|
+
/** What the viewer asks for. Deliberately not the viewer's own
|
|
1014
|
+
* `RunRequest`: that one carries local concerns (worker counts, debug
|
|
1015
|
+
* flags) the box decides for itself, and a box route that accepted them
|
|
1016
|
+
* would be a second way to configure a run. */
|
|
1017
|
+
interface BoxRunRequest {
|
|
1018
|
+
kind: "collection" | "scenario";
|
|
1019
|
+
/** Collection name, or a scenario ref (`folder/test`). */
|
|
1020
|
+
ref: string;
|
|
1021
|
+
}
|
|
1022
|
+
/** The daemon accepted the ticket. The run has NOT started — on a busy
|
|
1023
|
+
* box it may wait behind a suite for a while, which is the whole point
|
|
1024
|
+
* of there being one queue.
|
|
1025
|
+
*
|
|
1026
|
+
* No ticket name: the queue's file names are the box's own business,
|
|
1027
|
+
* and stopping a run goes back through `DELETE …/runs/<runId>` rather
|
|
1028
|
+
* than through the queue directly. The run id is the only handle a
|
|
1029
|
+
* caller needs, and the only one it is given. */
|
|
1030
|
+
interface BoxRunAccepted {
|
|
1031
|
+
runId: string;
|
|
1032
|
+
acceptedAt: number;
|
|
1033
|
+
}
|
|
1034
|
+
type BoxRunState = "queued" | "running" | "finished";
|
|
1035
|
+
interface BoxRunStatus {
|
|
1036
|
+
runId: string;
|
|
1037
|
+
state: BoxRunState;
|
|
1038
|
+
/** Present once the run ended. `null` when it died on a signal. */
|
|
1039
|
+
exitCode?: number | null;
|
|
1040
|
+
startedAt?: number;
|
|
1041
|
+
finishedAt?: number;
|
|
1042
|
+
}
|
|
1043
|
+
declare function parseBoxRunRequest(value: unknown): BoxRunRequest | null;
|
|
1044
|
+
declare function parseBoxRunAccepted(value: unknown): BoxRunAccepted | null;
|
|
1045
|
+
declare function parseBoxRunStatus(value: unknown): BoxRunStatus | null;
|
|
1046
|
+
|
|
1047
|
+
/** The variable a box injects an environment's target under — what the
|
|
1048
|
+
* suite's `baseUrl` auto-wires from. */
|
|
1049
|
+
declare const TARGET_ENV_VAR = "APP_BASE_URL";
|
|
1050
|
+
/** Prefix of the runner's own settings (`UNOTEST_HEADED`,
|
|
1051
|
+
* `UNOTEST_LOG_LEVEL`, …). They configure the machine a run happens on,
|
|
1052
|
+
* never the suite, so an environment on a box neither receives them from
|
|
1053
|
+
* `env push` nor is asked for them by a bundle's declared names. One
|
|
1054
|
+
* predicate for both sides: they used to disagree, and a box warned about
|
|
1055
|
+
* names a push could never have sent. */
|
|
1056
|
+
declare const RUNNER_SETTING_PREFIX = "UNOTEST_";
|
|
1057
|
+
declare function isRunnerSetting(name: string): boolean;
|
|
1058
|
+
/** Token-door root, relative to the box origin. The project is decided by
|
|
1059
|
+
* the token (`Authorization: Bearer <token>`), so the path names only the
|
|
1060
|
+
* environment:
|
|
1061
|
+
*
|
|
1062
|
+
* PATCH /api/box/values/<env> merge into the three layers
|
|
1063
|
+
* PUT /api/box/values/<env> replace all three layers
|
|
1064
|
+
* PUT /api/box/values/<env>/target {"value": "https://…"}
|
|
1065
|
+
* DELETE /api/box/values/<env>/target back to the config's
|
|
1066
|
+
* PUT /api/box/values/<env>/variables/<NAME> {"value": "…"}
|
|
1067
|
+
* DELETE /api/box/values/<env>/variables/<NAME>
|
|
1068
|
+
* PUT /api/box/values/<env>/secrets/<NAME> {"value": "…"}
|
|
1069
|
+
* DELETE /api/box/values/<env>/secrets/<NAME>
|
|
1070
|
+
*/
|
|
1071
|
+
declare const BOX_VALUES_PATH = "/api/box/values";
|
|
1072
|
+
/** Session-door root: the same operations for a signed-in admin, with the
|
|
1073
|
+
* project spelled out because a session is not scoped to one. Reachable
|
|
1074
|
+
* through the guard only, which stamps the actor; also answers
|
|
1075
|
+
* `GET …/values` with the readable view ({@link BoxEnvValuesView}), and
|
|
1076
|
+
* reveals secrets on request:
|
|
1077
|
+
*
|
|
1078
|
+
* PUT /api/box/envs/<project>/<env>/values the batch,
|
|
1079
|
+
* with `null` for a secret to keep ({@link BoxEnvValuesReplaceRequest})
|
|
1080
|
+
* GET /api/box/envs/<project>/<env>/values/secrets/<NAME>/reveal
|
|
1081
|
+
* GET /api/box/envs/<project>/<env>/values/reveal all secrets
|
|
1082
|
+
*/
|
|
1083
|
+
declare const BOX_ENV_VALUES_SEGMENT = "values";
|
|
1084
|
+
/** The verb a reveal path ends with. `reveal` is a legal variable name, so
|
|
1085
|
+
* the verb never sits in a NAME slot: for one secret it hangs BELOW the
|
|
1086
|
+
* name (a name has no children, nothing else can be there), for all of
|
|
1087
|
+
* them it hangs off the values root beside the kind segments, where a
|
|
1088
|
+
* name never appears. Each shape is distinct by segment count and literal
|
|
1089
|
+
* alone — no route has to lean on the HTTP method to tell a secret called
|
|
1090
|
+
* `reveal` from the verb. */
|
|
1091
|
+
declare const BOX_REVEAL_SEGMENT = "reveal";
|
|
1092
|
+
type BoxValueKind = "target" | "variable" | "secret";
|
|
1093
|
+
/** Kind for a path segment, or null for anything else. */
|
|
1094
|
+
declare function boxValueKindOfSegment(segment: string): Exclude<BoxValueKind, "target"> | null;
|
|
1095
|
+
/** `/api/box/values/<env>` — the batch. */
|
|
1096
|
+
declare function boxValuesPath(environment: string): string;
|
|
1097
|
+
/** `/api/box/values/<env>/target` or `/api/box/values/<env>/<kind>/<NAME>`. */
|
|
1098
|
+
declare function boxValuePath(environment: string, kind: BoxValueKind, name?: string): string;
|
|
1099
|
+
/** `/api/box/envs/<project>/<env>/values`. */
|
|
1100
|
+
declare function boxEnvValuesPath(project: string, environment: string): string;
|
|
1101
|
+
/** `/api/box/envs/<project>/<env>/values/target` or `…/values/<kind>/<NAME>`. */
|
|
1102
|
+
declare function boxEnvValuePath(project: string, environment: string, kind: BoxValueKind, name?: string): string;
|
|
1103
|
+
/** `/api/box/envs/<project>/<env>/values/secrets/<NAME>/reveal` — one
|
|
1104
|
+
* secret's value, session door only. */
|
|
1105
|
+
declare function boxEnvSecretRevealPath(project: string, environment: string, name: string): string;
|
|
1106
|
+
/** `/api/box/envs/<project>/<env>/values/reveal` — every secret's value,
|
|
1107
|
+
* session door only. Not under `secrets/` — see {@link BOX_REVEAL_SEGMENT}
|
|
1108
|
+
* for why the verb sits beside the kinds rather than among the names. */
|
|
1109
|
+
declare function boxEnvSecretsRevealPath(project: string, environment: string): string;
|
|
1110
|
+
/** The batch: what the environment should hold from now on. Whole layers,
|
|
1111
|
+
* not a diff — a name absent here is removed from the box. `target`
|
|
1112
|
+
* absent = drop the override, back to the operator's config. What the
|
|
1113
|
+
* admin's page sends; `env push` merges instead
|
|
1114
|
+
* ({@link BoxValuesMergeRequest}). */
|
|
1115
|
+
interface BoxValuesReplaceRequest {
|
|
1116
|
+
target?: string;
|
|
1117
|
+
variables: Record<string, string>;
|
|
1118
|
+
secrets: Record<string, string>;
|
|
1119
|
+
}
|
|
1120
|
+
/** The token-door merge, `PATCH /api/box/values/<env>`: every name in the
|
|
1121
|
+
* batch is set, a name the box holds and the batch does not stays — a
|
|
1122
|
+
* value someone put there with `env set` is not the pusher's to drop
|
|
1123
|
+
* silently. `target` absent keeps the override. A name sent in the other
|
|
1124
|
+
* layer than the box holds it moves there.
|
|
1125
|
+
*
|
|
1126
|
+
* `prune` drops what the batch does not carry, target included — except
|
|
1127
|
+
* runner settings ({@link isRunnerSetting}): a push never sends those, so
|
|
1128
|
+
* their absence from a batch says nothing about whether they are wanted. */
|
|
1129
|
+
interface BoxValuesMergeRequest extends BoxValuesReplaceRequest {
|
|
1130
|
+
prune?: boolean;
|
|
1131
|
+
}
|
|
1132
|
+
/** The session-door batch: the same whole-layer replace, except that a
|
|
1133
|
+
* secret may be sent as `null` — "keep whatever the box holds". The
|
|
1134
|
+
* admin's page never has the values of secrets it did not reveal, and
|
|
1135
|
+
* revealing them all just to send them back would fill the audit log
|
|
1136
|
+
* with looks nobody took. A name absent from `secrets` is still removed;
|
|
1137
|
+
* `null` keeps only a secret that exists (the box decides what a `null`
|
|
1138
|
+
* for an unknown name means). The token door has no such sentinel: a
|
|
1139
|
+
* pusher holds the real values. */
|
|
1140
|
+
interface BoxEnvValuesReplaceRequest extends Omit<BoxValuesReplaceRequest, "secrets"> {
|
|
1141
|
+
secrets: Record<string, string | null>;
|
|
1142
|
+
}
|
|
1143
|
+
interface BoxValueSetRequest {
|
|
1144
|
+
value: string;
|
|
1145
|
+
}
|
|
1146
|
+
/** Null for anything we will not act on. Names are validated here so a
|
|
1147
|
+
* key that could not be a variable never reaches a store; the RESERVED
|
|
1148
|
+
* name ({@link TARGET_ENV_VAR}) is not a parse failure — the box answers
|
|
1149
|
+
* it with its own code, because the fix is different ("send it as the
|
|
1150
|
+
* target", not "fix your JSON"). */
|
|
1151
|
+
declare function parseBoxValuesReplaceRequest(value: unknown): BoxValuesReplaceRequest | null;
|
|
1152
|
+
/** The session-door batch; `null` is a legal secret value, nothing else
|
|
1153
|
+
* beyond {@link parseBoxValuesReplaceRequest} changes. */
|
|
1154
|
+
declare function parseBoxEnvValuesReplaceRequest(value: unknown): BoxEnvValuesReplaceRequest | null;
|
|
1155
|
+
/** The token-door merge: the replace batch plus an optional `prune`. */
|
|
1156
|
+
declare function parseBoxValuesMergeRequest(value: unknown): BoxValuesMergeRequest | null;
|
|
1157
|
+
declare function parseBoxValueSetRequest(value: unknown): BoxValueSetRequest | null;
|
|
1158
|
+
/** Names in a batch that may not be set as a variable or a secret. */
|
|
1159
|
+
declare function reservedBoxValueNames(request: {
|
|
1160
|
+
variables: Record<string, unknown>;
|
|
1161
|
+
secrets: Record<string, unknown>;
|
|
1162
|
+
}): string[];
|
|
1163
|
+
/** Names per layer; `target` says whether the override is among them. */
|
|
1164
|
+
interface BoxValueNames {
|
|
1165
|
+
target: boolean;
|
|
1166
|
+
variables: string[];
|
|
1167
|
+
secrets: string[];
|
|
1168
|
+
}
|
|
1169
|
+
/** What the environment holds after a batch, by NAME, and what the batch
|
|
1170
|
+
* took away — so the CLI can say "removed STALE_KEY" instead of leaving
|
|
1171
|
+
* the pusher to diff two listings. */
|
|
1172
|
+
interface BoxValuesReplaced {
|
|
1173
|
+
status: "replaced";
|
|
1174
|
+
environment: string;
|
|
1175
|
+
/** Whether a target override is now in place. */
|
|
1176
|
+
target: boolean;
|
|
1177
|
+
variables: string[];
|
|
1178
|
+
secrets: string[];
|
|
1179
|
+
removed: BoxValueNames;
|
|
1180
|
+
}
|
|
1181
|
+
/** What a merge did, by NAME: what the environment holds now, what the
|
|
1182
|
+
* batch set, what it left in place (`kept` — on the box, not in the
|
|
1183
|
+
* batch), what `prune` took away, and the names that changed layer
|
|
1184
|
+
* (`moved.secrets` = was a variable, now a secret). A moved name is in
|
|
1185
|
+
* `set`, never in `removed`: it is still there. */
|
|
1186
|
+
interface BoxValuesMerged {
|
|
1187
|
+
status: "merged";
|
|
1188
|
+
environment: string;
|
|
1189
|
+
target: boolean;
|
|
1190
|
+
variables: string[];
|
|
1191
|
+
secrets: string[];
|
|
1192
|
+
set: BoxValueNames;
|
|
1193
|
+
kept: BoxValueNames;
|
|
1194
|
+
removed: BoxValueNames;
|
|
1195
|
+
moved: {
|
|
1196
|
+
variables: string[];
|
|
1197
|
+
secrets: string[];
|
|
1198
|
+
};
|
|
1199
|
+
}
|
|
1200
|
+
interface BoxValueChanged {
|
|
1201
|
+
status: "set" | "removed";
|
|
1202
|
+
environment: string;
|
|
1203
|
+
kind: BoxValueKind;
|
|
1204
|
+
name?: string;
|
|
1205
|
+
}
|
|
1206
|
+
/** Why a values request was refused. A code, not a message — the CLI
|
|
1207
|
+
* turns each into its own advice. */
|
|
1208
|
+
type BoxValuesErrorCode =
|
|
1209
|
+
/** Missing, unknown or revoked token; or no actor on the session door. */
|
|
1210
|
+
"unauthorized"
|
|
1211
|
+
/** The token may push bundles but was not minted with the values scope. */
|
|
1212
|
+
| "forbidden"
|
|
1213
|
+
/** A valid token for a project this box does not serve. */
|
|
1214
|
+
| "scope-mismatch"
|
|
1215
|
+
/** The token's project has no environment of that name. */
|
|
1216
|
+
| "unknown-environment"
|
|
1217
|
+
/** A reveal, or a `null` in a session-door batch, named a secret the
|
|
1218
|
+
* environment does not hold. */
|
|
1219
|
+
| "unknown-secret"
|
|
1220
|
+
/** A variable or secret named {@link TARGET_ENV_VAR} — send it as the
|
|
1221
|
+
* target instead. */
|
|
1222
|
+
| "reserved"
|
|
1223
|
+
/** Not a readable request. */
|
|
1224
|
+
| "malformed"
|
|
1225
|
+
/** The box has the path but not the method — the daemon's router says
|
|
1226
|
+
* so for any path. On the values door it means a box older than the
|
|
1227
|
+
* request: a merging `env push` against a box that only replaces. The
|
|
1228
|
+
* box changed nothing. */
|
|
1229
|
+
| "method"
|
|
1230
|
+
/** A cloud-minted token whose `exp` has passed, with nothing else wrong
|
|
1231
|
+
* with it: this box's operator key signed it, for the right kind, for
|
|
1232
|
+
* this box. Its own code because the answer differs from every other
|
|
1233
|
+
* refusal — ask the cloud for another pair and retry, rather than "this
|
|
1234
|
+
* credential is wrong". Only the holder of a genuinely signed token for
|
|
1235
|
+
* THIS box ever sees it, so it tells a guesser nothing. */
|
|
1236
|
+
| "expired"
|
|
1237
|
+
/** This box has never read the operator's revocation list, so it cannot
|
|
1238
|
+
* tell a live cloud-minted token from a withdrawn one and takes
|
|
1239
|
+
* neither. A state of the BOX: send the SAME token again after
|
|
1240
|
+
* `retryAfterSeconds`, never mint a new one. */
|
|
1241
|
+
| "revocation-list-unavailable"
|
|
1242
|
+
/** A cloud-minted token that names no project, on a box that serves
|
|
1243
|
+
* several. The message lists them; the token has to name one. */
|
|
1244
|
+
| "ambiguous-project"
|
|
1245
|
+
/** The box could not write its state. Retryable. */
|
|
1246
|
+
| "storage";
|
|
1247
|
+
/** On an `unknown-environment` refusal, from a box that says it: the
|
|
1248
|
+
* project the caller's token belongs to and the environments it has —
|
|
1249
|
+
* so a client can list them and name the command that adds the missing
|
|
1250
|
+
* one. Never another project's names. */
|
|
1251
|
+
interface UnknownEnvironmentDetail {
|
|
1252
|
+
project: string;
|
|
1253
|
+
environments: string[];
|
|
1254
|
+
}
|
|
1255
|
+
interface BoxValuesError {
|
|
1256
|
+
error: {
|
|
1257
|
+
code: BoxValuesErrorCode;
|
|
1258
|
+
message: string;
|
|
1259
|
+
} & Partial<UnknownEnvironmentDetail>;
|
|
1260
|
+
}
|
|
1261
|
+
/** The detail of a refusal, when it is there and readable. Advisory: a
|
|
1262
|
+
* field of the wrong shape drops the detail, never the refusal. */
|
|
1263
|
+
declare function parseUnknownEnvironmentDetail(error: Record<string, unknown>): Partial<UnknownEnvironmentDetail>;
|
|
1264
|
+
type BoxValuesResponse = BoxValuesReplaced | BoxValuesMerged | BoxValueChanged | BoxValuesError;
|
|
1265
|
+
/** Parse a box's answer. Null when the body is not one of ours at all —
|
|
1266
|
+
* a proxy's HTML error page, a captive portal — which the caller reports
|
|
1267
|
+
* as "that URL is not a box". */
|
|
1268
|
+
declare function parseBoxValuesResponse(value: unknown): BoxValuesResponse | null;
|
|
1269
|
+
/** One secret's value, from `GET …/secrets/<NAME>/reveal`. */
|
|
1270
|
+
interface BoxSecretRevealResponse {
|
|
1271
|
+
value: string;
|
|
1272
|
+
}
|
|
1273
|
+
/** Every secret's value by name, from `GET …/values/reveal`. */
|
|
1274
|
+
type BoxSecretsRevealResponse = Record<string, string>;
|
|
1275
|
+
declare function parseBoxSecretRevealResponse(value: unknown): BoxSecretRevealResponse | null;
|
|
1276
|
+
declare function parseBoxSecretsRevealResponse(value: unknown): BoxSecretsRevealResponse | null;
|
|
1277
|
+
/** What an admin sees: where each non-secret value comes from, and the
|
|
1278
|
+
* NAMES of the secrets. A secret's value is never in the view — it comes
|
|
1279
|
+
* back only through a reveal ({@link parseBoxSecretRevealResponse}), one
|
|
1280
|
+
* request per look. */
|
|
1281
|
+
interface BoxEnvValuesView {
|
|
1282
|
+
project: string;
|
|
1283
|
+
environment: string;
|
|
1284
|
+
target: {
|
|
1285
|
+
configured: string;
|
|
1286
|
+
override: string | null;
|
|
1287
|
+
};
|
|
1288
|
+
variables: {
|
|
1289
|
+
name: string;
|
|
1290
|
+
value: string;
|
|
1291
|
+
source: "config" | "box";
|
|
1292
|
+
}[];
|
|
1293
|
+
secrets: string[];
|
|
1294
|
+
}
|
|
1295
|
+
|
|
993
1296
|
/** Run endpoint, relative to the box origin:
|
|
994
1297
|
* `POST <origin>/api/box/ci/run` with `Authorization: Bearer <token>` —
|
|
995
1298
|
* the same project token that uploaded the bundle. */
|
|
996
1299
|
declare const CI_RUN_PATH = "/api/box/ci/run";
|
|
1300
|
+
/** Where a run ordered through {@link CI_RUN_PATH} can be followed:
|
|
1301
|
+
* `GET <origin>/api/box/ci/runs/<runId>` with the SAME token that ordered
|
|
1302
|
+
* it. Only that token: a run ordered by another, and a run that does not
|
|
1303
|
+
* exist, get one and the same answer. The answer is a
|
|
1304
|
+
* {@link BoxRunStatus}, the shape the viewer polls its own runs with. */
|
|
1305
|
+
declare const CI_RUNS_PATH = "/api/box/ci/runs";
|
|
997
1306
|
/** Where a ticket came from, when it came from a machine.
|
|
998
1307
|
*
|
|
999
1308
|
* `api` is the honest answer for `POST /ci/run`: the caller is somebody's
|
|
@@ -1028,6 +1337,9 @@ interface CiRunRequest {
|
|
|
1028
1337
|
interface CiQueuedRun {
|
|
1029
1338
|
runId: string;
|
|
1030
1339
|
collection: string;
|
|
1340
|
+
/** The run in the box's viewer. Absent when the box does not know the
|
|
1341
|
+
* origin it is reached at — and from boxes older than the field. */
|
|
1342
|
+
url?: string;
|
|
1031
1343
|
}
|
|
1032
1344
|
interface CiRunAccepted {
|
|
1033
1345
|
status: "queued";
|
|
@@ -1100,9 +1412,25 @@ interface CiRunError {
|
|
|
1100
1412
|
error: {
|
|
1101
1413
|
code: CiRunErrorCode;
|
|
1102
1414
|
message: string;
|
|
1103
|
-
}
|
|
1415
|
+
} & Partial<UnknownEnvironmentDetail>;
|
|
1104
1416
|
}
|
|
1105
1417
|
type CiRunResponse = CiRunAccepted | CiRunError;
|
|
1418
|
+
/** Why a run's state was not given. The door's own refusals, plus one:
|
|
1419
|
+
* `unknown-run` is a run this token did not order, one that never
|
|
1420
|
+
* existed, and one the box no longer remembers (it restarted, or the run
|
|
1421
|
+
* ended long ago) — one code, because telling them apart would tell a
|
|
1422
|
+
* guesser which ids exist. */
|
|
1423
|
+
type CiRunStatusErrorCode = "unauthorized" | "scope-mismatch" | "expired" | "revocation-list-unavailable" | "ambiguous-project" | "unknown-run";
|
|
1424
|
+
interface CiRunStatusError {
|
|
1425
|
+
error: {
|
|
1426
|
+
code: CiRunStatusErrorCode;
|
|
1427
|
+
message: string;
|
|
1428
|
+
};
|
|
1429
|
+
}
|
|
1430
|
+
type CiRunStatusResponse = BoxRunStatus | CiRunStatusError;
|
|
1431
|
+
/** Parse a box's answer about one run. Null when it is not one of ours —
|
|
1432
|
+
* which is also what a box too old to have this route answers. */
|
|
1433
|
+
declare function parseCiRunStatusResponse(value: unknown): CiRunStatusResponse | null;
|
|
1106
1434
|
/** Validate a request off the wire. Null for anything we will not act on:
|
|
1107
1435
|
* the box answers `malformed` rather than filling in a default, because
|
|
1108
1436
|
* every default here would be "run something nobody asked for". */
|
|
@@ -1114,6 +1442,44 @@ declare function parseCiRunResponse(value: unknown): CiRunResponse | null;
|
|
|
1114
1442
|
/** Structural validation of the CI provenance carried on a queue ticket.
|
|
1115
1443
|
* Shared by the ticket parser and by whoever reads a ticket back. */
|
|
1116
1444
|
declare function parseCiProvider(value: unknown): CiProviderId | null;
|
|
1445
|
+
/** `GET /api/box/ci/runs/<runId>/lines?after=<n>` — what the run printed,
|
|
1446
|
+
* for a CI log. Same door and same owner rule as the status: a run this
|
|
1447
|
+
* token ordered, and nothing else. */
|
|
1448
|
+
declare function ciRunLinesPath(runId: string): string;
|
|
1449
|
+
/** The query parameter the cursor travels in. */
|
|
1450
|
+
declare const CI_RUN_LINES_AFTER = "after";
|
|
1451
|
+
/** Most lines one answer carries; `next` leads on to the rest. */
|
|
1452
|
+
declare const CI_RUN_LINES_MAX = 500;
|
|
1453
|
+
/** One line of a run, read off its journal. The box decides what is
|
|
1454
|
+
* worth a CI log (a scenario starting and ending, a failed step with its
|
|
1455
|
+
* error, `log` and `note`); the client decides how it looks. Secrets are
|
|
1456
|
+
* masked before the line leaves the box. */
|
|
1457
|
+
interface CiRunLine {
|
|
1458
|
+
kind: "scenario-started" | "step-failed" | "log" | "note" | "scenario-finished";
|
|
1459
|
+
/** The scenario the line belongs to. */
|
|
1460
|
+
scenario: string;
|
|
1461
|
+
/** `step-failed`: `file:line ErrorName: message`; `log` / `note`: the
|
|
1462
|
+
* text (a note as `label: text`); the scenario lines: empty. */
|
|
1463
|
+
text: string;
|
|
1464
|
+
/** `scenario-finished` only. */
|
|
1465
|
+
outcome?: RunOutcome;
|
|
1466
|
+
}
|
|
1467
|
+
interface CiRunLines {
|
|
1468
|
+
runId: string;
|
|
1469
|
+
lines: CiRunLine[];
|
|
1470
|
+
/** The cursor for the next ask: lines already given out, counted from
|
|
1471
|
+
* the start of the run. Stable — a line once given is never given
|
|
1472
|
+
* again under another number. */
|
|
1473
|
+
next: number;
|
|
1474
|
+
/** The journal has its ending: no line will follow. */
|
|
1475
|
+
done: boolean;
|
|
1476
|
+
}
|
|
1477
|
+
type CiRunLinesResponse = CiRunLines | CiRunStatusError;
|
|
1478
|
+
/** Parse a box's answer. Null when it is not one of ours. A refusal is in
|
|
1479
|
+
* the status vocabulary — and an older box, which has no such route,
|
|
1480
|
+
* answers `malformed`, which this parser does not take: the caller reads
|
|
1481
|
+
* that as "this box does not stream lines". */
|
|
1482
|
+
declare function parseCiRunLinesResponse(value: unknown): CiRunLinesResponse | null;
|
|
1117
1483
|
|
|
1118
1484
|
/** Queue root under `unotest/`, mirroring the two axes of `runsDirFor`:
|
|
1119
1485
|
* TARGET (dash) and ENVIRONMENT (dot) — `.queue`, `.queue-mobile`,
|
|
@@ -1492,11 +1858,26 @@ interface BundleVariableGap {
|
|
|
1492
1858
|
/** Declared by the bundle, provided by neither variables nor secrets. */
|
|
1493
1859
|
missing: string[];
|
|
1494
1860
|
}
|
|
1861
|
+
/** The bundle's repository, which no project on the box claims. The
|
|
1862
|
+
* upload still lands — in the token's project — but nothing on the box
|
|
1863
|
+
* ties that repository to it, so a token for the wrong project would
|
|
1864
|
+
* have landed it just as quietly (#231). A fact, not a sentence: the
|
|
1865
|
+
* client says what to do about it. */
|
|
1866
|
+
interface BundleUnmappedRepo {
|
|
1867
|
+
repo: string;
|
|
1868
|
+
}
|
|
1495
1869
|
interface BundleUploadOk {
|
|
1496
1870
|
status: BundleUploadStatus;
|
|
1497
1871
|
bundleId: string;
|
|
1498
1872
|
/** Present only when something is missing somewhere. */
|
|
1499
1873
|
variableGaps?: BundleVariableGap[];
|
|
1874
|
+
/** The project the bundle landed in. Absent from a box older than this
|
|
1875
|
+
* field; a client then says nothing rather than guess. */
|
|
1876
|
+
project?: string;
|
|
1877
|
+
/** The label of the token that pushed it, as the box's operator wrote it. */
|
|
1878
|
+
tokenLabel?: string;
|
|
1879
|
+
/** Present only when the bundle's repository maps to no project. */
|
|
1880
|
+
unmappedRepo?: BundleUnmappedRepo;
|
|
1500
1881
|
}
|
|
1501
1882
|
/** Why an upload was refused. A code, not a message, because the CLI
|
|
1502
1883
|
* turns each into its own advice — and because matching on message text
|
|
@@ -1558,20 +1939,92 @@ interface BundleUploadErrorDetail {
|
|
|
1558
1939
|
scope?: BundleScopeMismatch;
|
|
1559
1940
|
/** The project the presented token is scoped to. */
|
|
1560
1941
|
project?: string;
|
|
1561
|
-
/** The projects this box serves. */
|
|
1562
|
-
projects?: readonly string[];
|
|
1942
|
+
/** The projects this box serves. */
|
|
1943
|
+
projects?: readonly string[];
|
|
1944
|
+
}
|
|
1945
|
+
interface BundleUploadError {
|
|
1946
|
+
error: {
|
|
1947
|
+
code: BundleUploadErrorCode;
|
|
1948
|
+
message: string;
|
|
1949
|
+
} & BundleUploadErrorDetail;
|
|
1950
|
+
}
|
|
1951
|
+
type BundleUploadResponse = BundleUploadOk | BundleUploadError;
|
|
1952
|
+
/** Parse a box's answer. Null when the body is not one of ours at all —
|
|
1953
|
+
* a proxy's HTML error page, a captive portal — which the caller reports
|
|
1954
|
+
* as "that URL is not a box" rather than as a bundle problem. */
|
|
1955
|
+
declare function parseBundleUploadResponse(value: unknown): BundleUploadResponse | null;
|
|
1956
|
+
/** `DELETE /api/box/bundles/<id>` with the project token, body optional:
|
|
1957
|
+
* `{"switchTo": "<id>"}` points every environment that runs the bundle at
|
|
1958
|
+
* another one of the same project first. */
|
|
1959
|
+
interface BundleRemoveRequest {
|
|
1960
|
+
switchTo?: string;
|
|
1961
|
+
}
|
|
1962
|
+
/** Null for a body that is not one; an absent body is `{}`. */
|
|
1963
|
+
declare function parseBundleRemoveRequest(value: unknown): BundleRemoveRequest | null;
|
|
1964
|
+
/** The bundle and its files are gone from the token's project. */
|
|
1965
|
+
interface BundleRemoved {
|
|
1966
|
+
status: "removed";
|
|
1967
|
+
bundleId: string;
|
|
1968
|
+
project: string;
|
|
1969
|
+
}
|
|
1970
|
+
/** `switchTo` was asked and the bundle was current somewhere: those
|
|
1971
|
+
* environments are switching, and the bundle is still there. Removal is
|
|
1972
|
+
* a second `bundle rm` once the switches land — the box keeps no pending
|
|
1973
|
+
* removal that a restart could drop without a word. */
|
|
1974
|
+
interface BundleSwitching {
|
|
1975
|
+
status: "switching";
|
|
1976
|
+
bundleId: string;
|
|
1977
|
+
project: string;
|
|
1978
|
+
switchTo: string;
|
|
1979
|
+
environments: string[];
|
|
1980
|
+
}
|
|
1981
|
+
type BundleRemoveOk = BundleRemoved | BundleSwitching;
|
|
1982
|
+
/** What holds a bundle that may not be removed yet. `current`: the
|
|
1983
|
+
* environment runs it; `followsBranch` is set when that environment
|
|
1984
|
+
* follows a branch and cannot be switched by hand. `waiting` / `running`:
|
|
1985
|
+
* a ticket in its queue — a run, or a switch to it — asked for it. */
|
|
1986
|
+
interface BundleUse {
|
|
1987
|
+
environment: string;
|
|
1988
|
+
reason: "current" | "waiting" | "running";
|
|
1989
|
+
followsBranch?: string;
|
|
1990
|
+
}
|
|
1991
|
+
type BundleRemoveErrorCode =
|
|
1992
|
+
/** Missing, unknown or revoked token. */
|
|
1993
|
+
"unauthorized"
|
|
1994
|
+
/** A token for a project this box does not serve. */
|
|
1995
|
+
| "scope-mismatch"
|
|
1996
|
+
/** See {@link BundleUploadErrorCode}. */
|
|
1997
|
+
| "expired" | "revocation-list-unavailable" | "ambiguous-project"
|
|
1998
|
+
/** The token's project holds no such bundle. Said the same way whether
|
|
1999
|
+
* another project holds it or none does: a token learns nothing about
|
|
2000
|
+
* projects that are not its own. */
|
|
2001
|
+
| "unknown-bundle"
|
|
2002
|
+
/** `switchTo` names a bundle the token's project does not hold. */
|
|
2003
|
+
| "unknown-target"
|
|
2004
|
+
/** Something still uses the bundle — `uses` says what. Nothing changed. */
|
|
2005
|
+
| "in-use"
|
|
2006
|
+
/** Not a bundle id, or not a readable body. */
|
|
2007
|
+
| "malformed"
|
|
2008
|
+
/** The box has the path but not the method: older than bundle removal.
|
|
2009
|
+
* Nothing changed. */
|
|
2010
|
+
| "method"
|
|
2011
|
+
/** The box could not remove it. Retryable. */
|
|
2012
|
+
| "storage";
|
|
2013
|
+
interface BundleRemoveErrorDetail {
|
|
2014
|
+
/** On `in-use`. */
|
|
2015
|
+
uses?: BundleUse[];
|
|
2016
|
+
/** The project the presented token is scoped to. */
|
|
2017
|
+
project?: string;
|
|
1563
2018
|
}
|
|
1564
|
-
interface
|
|
2019
|
+
interface BundleRemoveError {
|
|
1565
2020
|
error: {
|
|
1566
|
-
code:
|
|
2021
|
+
code: BundleRemoveErrorCode;
|
|
1567
2022
|
message: string;
|
|
1568
|
-
} &
|
|
2023
|
+
} & BundleRemoveErrorDetail;
|
|
1569
2024
|
}
|
|
1570
|
-
type
|
|
1571
|
-
/** Parse a box's answer
|
|
1572
|
-
|
|
1573
|
-
* as "that URL is not a box" rather than as a bundle problem. */
|
|
1574
|
-
declare function parseBundleUploadResponse(value: unknown): BundleUploadResponse | null;
|
|
2025
|
+
type BundleRemoveResponse = BundleRemoveOk | BundleRemoveError;
|
|
2026
|
+
/** Parse a box's answer to a removal; null when it is not one of ours. */
|
|
2027
|
+
declare function parseBundleRemoveResponse(value: unknown): BundleRemoveResponse | null;
|
|
1575
2028
|
|
|
1576
2029
|
/** Engine for this run: `chromium` | `firefox` | `webkit`. Overrides the
|
|
1577
2030
|
* first entry of `config.browsers`. */
|
|
@@ -1598,203 +2051,6 @@ declare function encodeNameList(names: readonly string[]): string;
|
|
|
1598
2051
|
/** Decode a `*_NAMES_ENV` value; unset / blank → []. */
|
|
1599
2052
|
declare function decodeNameList(raw: string | undefined): string[];
|
|
1600
2053
|
|
|
1601
|
-
/** The variable a box injects an environment's target under — what the
|
|
1602
|
-
* suite's `baseUrl` auto-wires from. */
|
|
1603
|
-
declare const TARGET_ENV_VAR = "APP_BASE_URL";
|
|
1604
|
-
/** Prefix of the runner's own settings (`UNOTEST_HEADED`,
|
|
1605
|
-
* `UNOTEST_LOG_LEVEL`, …). They configure the machine a run happens on,
|
|
1606
|
-
* never the suite, so an environment on a box neither receives them from
|
|
1607
|
-
* `env push` nor is asked for them by a bundle's declared names. One
|
|
1608
|
-
* predicate for both sides: they used to disagree, and a box warned about
|
|
1609
|
-
* names a push could never have sent. */
|
|
1610
|
-
declare const RUNNER_SETTING_PREFIX = "UNOTEST_";
|
|
1611
|
-
declare function isRunnerSetting(name: string): boolean;
|
|
1612
|
-
/** Token-door root, relative to the box origin. The project is decided by
|
|
1613
|
-
* the token (`Authorization: Bearer <token>`), so the path names only the
|
|
1614
|
-
* environment:
|
|
1615
|
-
*
|
|
1616
|
-
* PUT /api/box/values/<env> replace all three layers
|
|
1617
|
-
* PUT /api/box/values/<env>/target {"value": "https://…"}
|
|
1618
|
-
* DELETE /api/box/values/<env>/target back to the config's
|
|
1619
|
-
* PUT /api/box/values/<env>/variables/<NAME> {"value": "…"}
|
|
1620
|
-
* DELETE /api/box/values/<env>/variables/<NAME>
|
|
1621
|
-
* PUT /api/box/values/<env>/secrets/<NAME> {"value": "…"}
|
|
1622
|
-
* DELETE /api/box/values/<env>/secrets/<NAME>
|
|
1623
|
-
*/
|
|
1624
|
-
declare const BOX_VALUES_PATH = "/api/box/values";
|
|
1625
|
-
/** Session-door root: the same operations for a signed-in admin, with the
|
|
1626
|
-
* project spelled out because a session is not scoped to one. Reachable
|
|
1627
|
-
* through the guard only, which stamps the actor; also answers
|
|
1628
|
-
* `GET …/values` with the readable view ({@link BoxEnvValuesView}), and
|
|
1629
|
-
* reveals secrets on request:
|
|
1630
|
-
*
|
|
1631
|
-
* PUT /api/box/envs/<project>/<env>/values the batch,
|
|
1632
|
-
* with `null` for a secret to keep ({@link BoxEnvValuesReplaceRequest})
|
|
1633
|
-
* GET /api/box/envs/<project>/<env>/values/secrets/<NAME>/reveal
|
|
1634
|
-
* GET /api/box/envs/<project>/<env>/values/reveal all secrets
|
|
1635
|
-
*/
|
|
1636
|
-
declare const BOX_ENV_VALUES_SEGMENT = "values";
|
|
1637
|
-
/** The verb a reveal path ends with. `reveal` is a legal variable name, so
|
|
1638
|
-
* the verb never sits in a NAME slot: for one secret it hangs BELOW the
|
|
1639
|
-
* name (a name has no children, nothing else can be there), for all of
|
|
1640
|
-
* them it hangs off the values root beside the kind segments, where a
|
|
1641
|
-
* name never appears. Each shape is distinct by segment count and literal
|
|
1642
|
-
* alone — no route has to lean on the HTTP method to tell a secret called
|
|
1643
|
-
* `reveal` from the verb. */
|
|
1644
|
-
declare const BOX_REVEAL_SEGMENT = "reveal";
|
|
1645
|
-
type BoxValueKind = "target" | "variable" | "secret";
|
|
1646
|
-
/** Kind for a path segment, or null for anything else. */
|
|
1647
|
-
declare function boxValueKindOfSegment(segment: string): Exclude<BoxValueKind, "target"> | null;
|
|
1648
|
-
/** `/api/box/values/<env>` — the batch. */
|
|
1649
|
-
declare function boxValuesPath(environment: string): string;
|
|
1650
|
-
/** `/api/box/values/<env>/target` or `/api/box/values/<env>/<kind>/<NAME>`. */
|
|
1651
|
-
declare function boxValuePath(environment: string, kind: BoxValueKind, name?: string): string;
|
|
1652
|
-
/** `/api/box/envs/<project>/<env>/values`. */
|
|
1653
|
-
declare function boxEnvValuesPath(project: string, environment: string): string;
|
|
1654
|
-
/** `/api/box/envs/<project>/<env>/values/target` or `…/values/<kind>/<NAME>`. */
|
|
1655
|
-
declare function boxEnvValuePath(project: string, environment: string, kind: BoxValueKind, name?: string): string;
|
|
1656
|
-
/** `/api/box/envs/<project>/<env>/values/secrets/<NAME>/reveal` — one
|
|
1657
|
-
* secret's value, session door only. */
|
|
1658
|
-
declare function boxEnvSecretRevealPath(project: string, environment: string, name: string): string;
|
|
1659
|
-
/** `/api/box/envs/<project>/<env>/values/reveal` — every secret's value,
|
|
1660
|
-
* session door only. Not under `secrets/` — see {@link BOX_REVEAL_SEGMENT}
|
|
1661
|
-
* for why the verb sits beside the kinds rather than among the names. */
|
|
1662
|
-
declare function boxEnvSecretsRevealPath(project: string, environment: string): string;
|
|
1663
|
-
/** The batch: what the environment should hold from now on. Whole layers,
|
|
1664
|
-
* not a diff — a name absent here is removed from the box, so the local
|
|
1665
|
-
* files stay the single description of the environment and nothing
|
|
1666
|
-
* lingers on the box that nobody can see from the repository. `target`
|
|
1667
|
-
* absent = drop the override, back to the operator's config. */
|
|
1668
|
-
interface BoxValuesReplaceRequest {
|
|
1669
|
-
target?: string;
|
|
1670
|
-
variables: Record<string, string>;
|
|
1671
|
-
secrets: Record<string, string>;
|
|
1672
|
-
}
|
|
1673
|
-
/** The session-door batch: the same whole-layer replace, except that a
|
|
1674
|
-
* secret may be sent as `null` — "keep whatever the box holds". The
|
|
1675
|
-
* admin's page never has the values of secrets it did not reveal, and
|
|
1676
|
-
* revealing them all just to send them back would fill the audit log
|
|
1677
|
-
* with looks nobody took. A name absent from `secrets` is still removed;
|
|
1678
|
-
* `null` keeps only a secret that exists (the box decides what a `null`
|
|
1679
|
-
* for an unknown name means). The token door has no such sentinel: a
|
|
1680
|
-
* pusher holds the real values. */
|
|
1681
|
-
interface BoxEnvValuesReplaceRequest extends Omit<BoxValuesReplaceRequest, "secrets"> {
|
|
1682
|
-
secrets: Record<string, string | null>;
|
|
1683
|
-
}
|
|
1684
|
-
interface BoxValueSetRequest {
|
|
1685
|
-
value: string;
|
|
1686
|
-
}
|
|
1687
|
-
/** Null for anything we will not act on. Names are validated here so a
|
|
1688
|
-
* key that could not be a variable never reaches a store; the RESERVED
|
|
1689
|
-
* name ({@link TARGET_ENV_VAR}) is not a parse failure — the box answers
|
|
1690
|
-
* it with its own code, because the fix is different ("send it as the
|
|
1691
|
-
* target", not "fix your JSON"). */
|
|
1692
|
-
declare function parseBoxValuesReplaceRequest(value: unknown): BoxValuesReplaceRequest | null;
|
|
1693
|
-
/** The session-door batch; `null` is a legal secret value, nothing else
|
|
1694
|
-
* beyond {@link parseBoxValuesReplaceRequest} changes. */
|
|
1695
|
-
declare function parseBoxEnvValuesReplaceRequest(value: unknown): BoxEnvValuesReplaceRequest | null;
|
|
1696
|
-
declare function parseBoxValueSetRequest(value: unknown): BoxValueSetRequest | null;
|
|
1697
|
-
/** Names in a batch that may not be set as a variable or a secret. */
|
|
1698
|
-
declare function reservedBoxValueNames(request: {
|
|
1699
|
-
variables: Record<string, unknown>;
|
|
1700
|
-
secrets: Record<string, unknown>;
|
|
1701
|
-
}): string[];
|
|
1702
|
-
/** What the environment holds after a batch, by NAME, and what the batch
|
|
1703
|
-
* took away — so the CLI can say "removed STALE_KEY" instead of leaving
|
|
1704
|
-
* the pusher to diff two listings. */
|
|
1705
|
-
interface BoxValuesReplaced {
|
|
1706
|
-
status: "replaced";
|
|
1707
|
-
environment: string;
|
|
1708
|
-
/** Whether a target override is now in place. */
|
|
1709
|
-
target: boolean;
|
|
1710
|
-
variables: string[];
|
|
1711
|
-
secrets: string[];
|
|
1712
|
-
removed: {
|
|
1713
|
-
target: boolean;
|
|
1714
|
-
variables: string[];
|
|
1715
|
-
secrets: string[];
|
|
1716
|
-
};
|
|
1717
|
-
}
|
|
1718
|
-
interface BoxValueChanged {
|
|
1719
|
-
status: "set" | "removed";
|
|
1720
|
-
environment: string;
|
|
1721
|
-
kind: BoxValueKind;
|
|
1722
|
-
name?: string;
|
|
1723
|
-
}
|
|
1724
|
-
/** Why a values request was refused. A code, not a message — the CLI
|
|
1725
|
-
* turns each into its own advice. */
|
|
1726
|
-
type BoxValuesErrorCode =
|
|
1727
|
-
/** Missing, unknown or revoked token; or no actor on the session door. */
|
|
1728
|
-
"unauthorized"
|
|
1729
|
-
/** The token may push bundles but was not minted with the values scope. */
|
|
1730
|
-
| "forbidden"
|
|
1731
|
-
/** A valid token for a project this box does not serve. */
|
|
1732
|
-
| "scope-mismatch"
|
|
1733
|
-
/** The token's project has no environment of that name. */
|
|
1734
|
-
| "unknown-environment"
|
|
1735
|
-
/** A reveal, or a `null` in a session-door batch, named a secret the
|
|
1736
|
-
* environment does not hold. */
|
|
1737
|
-
| "unknown-secret"
|
|
1738
|
-
/** A variable or secret named {@link TARGET_ENV_VAR} — send it as the
|
|
1739
|
-
* target instead. */
|
|
1740
|
-
| "reserved"
|
|
1741
|
-
/** Not a readable request. */
|
|
1742
|
-
| "malformed"
|
|
1743
|
-
/** A cloud-minted token whose `exp` has passed, with nothing else wrong
|
|
1744
|
-
* with it: this box's operator key signed it, for the right kind, for
|
|
1745
|
-
* this box. Its own code because the answer differs from every other
|
|
1746
|
-
* refusal — ask the cloud for another pair and retry, rather than "this
|
|
1747
|
-
* credential is wrong". Only the holder of a genuinely signed token for
|
|
1748
|
-
* THIS box ever sees it, so it tells a guesser nothing. */
|
|
1749
|
-
| "expired"
|
|
1750
|
-
/** This box has never read the operator's revocation list, so it cannot
|
|
1751
|
-
* tell a live cloud-minted token from a withdrawn one and takes
|
|
1752
|
-
* neither. A state of the BOX: send the SAME token again after
|
|
1753
|
-
* `retryAfterSeconds`, never mint a new one. */
|
|
1754
|
-
| "revocation-list-unavailable"
|
|
1755
|
-
/** A cloud-minted token that names no project, on a box that serves
|
|
1756
|
-
* several. The message lists them; the token has to name one. */
|
|
1757
|
-
| "ambiguous-project"
|
|
1758
|
-
/** The box could not write its state. Retryable. */
|
|
1759
|
-
| "storage";
|
|
1760
|
-
interface BoxValuesError {
|
|
1761
|
-
error: {
|
|
1762
|
-
code: BoxValuesErrorCode;
|
|
1763
|
-
message: string;
|
|
1764
|
-
};
|
|
1765
|
-
}
|
|
1766
|
-
type BoxValuesResponse = BoxValuesReplaced | BoxValueChanged | BoxValuesError;
|
|
1767
|
-
/** Parse a box's answer. Null when the body is not one of ours at all —
|
|
1768
|
-
* a proxy's HTML error page, a captive portal — which the caller reports
|
|
1769
|
-
* as "that URL is not a box". */
|
|
1770
|
-
declare function parseBoxValuesResponse(value: unknown): BoxValuesResponse | null;
|
|
1771
|
-
/** One secret's value, from `GET …/secrets/<NAME>/reveal`. */
|
|
1772
|
-
interface BoxSecretRevealResponse {
|
|
1773
|
-
value: string;
|
|
1774
|
-
}
|
|
1775
|
-
/** Every secret's value by name, from `GET …/values/reveal`. */
|
|
1776
|
-
type BoxSecretsRevealResponse = Record<string, string>;
|
|
1777
|
-
declare function parseBoxSecretRevealResponse(value: unknown): BoxSecretRevealResponse | null;
|
|
1778
|
-
declare function parseBoxSecretsRevealResponse(value: unknown): BoxSecretsRevealResponse | null;
|
|
1779
|
-
/** What an admin sees: where each non-secret value comes from, and the
|
|
1780
|
-
* NAMES of the secrets. A secret's value is never in the view — it comes
|
|
1781
|
-
* back only through a reveal ({@link parseBoxSecretRevealResponse}), one
|
|
1782
|
-
* request per look. */
|
|
1783
|
-
interface BoxEnvValuesView {
|
|
1784
|
-
project: string;
|
|
1785
|
-
environment: string;
|
|
1786
|
-
target: {
|
|
1787
|
-
configured: string;
|
|
1788
|
-
override: string | null;
|
|
1789
|
-
};
|
|
1790
|
-
variables: {
|
|
1791
|
-
name: string;
|
|
1792
|
-
value: string;
|
|
1793
|
-
source: "config" | "box";
|
|
1794
|
-
}[];
|
|
1795
|
-
secrets: string[];
|
|
1796
|
-
}
|
|
1797
|
-
|
|
1798
2054
|
declare const RUN_MANIFEST_FILE = "manifest.json";
|
|
1799
2055
|
interface RunManifest {
|
|
1800
2056
|
/** Format-version of this manifest. Bump only on breaking schema
|
|
@@ -2267,55 +2523,6 @@ declare function parseBoxReadError(value: unknown): BoxReadErrorBody | null;
|
|
|
2267
2523
|
* not recognise is not a box answering. */
|
|
2268
2524
|
declare function parseBoxReadEnvironments(value: unknown): BoxReadEnvironment[] | null;
|
|
2269
2525
|
|
|
2270
|
-
declare const BOX_RUNS_SEGMENT = "runs";
|
|
2271
|
-
/** Set by the guard, forwarded by the viewer verbatim, verified by the
|
|
2272
|
-
* daemon: WHO clicked, in a form the thing in between cannot write.
|
|
2273
|
-
* Named here because three packages have to spell it identically and
|
|
2274
|
-
* this is the one they all already depend on — the signing and the
|
|
2275
|
-
* verification live on the box side (`@unotest/box-kit`), which is
|
|
2276
|
-
* where the secret is. */
|
|
2277
|
-
declare const ACTOR_TICKET_HEADER = "x-unotest-actor-ticket";
|
|
2278
|
-
/** Set by the guard on its own requests to the daemon. The daemon reads
|
|
2279
|
-
* the actor label only next to a valid one. */
|
|
2280
|
-
declare const GUARD_SECRET_HEADER = "x-unotest-guard-secret";
|
|
2281
|
-
/** `/api/box/envs/<project>/<env>/runs`. */
|
|
2282
|
-
declare function boxRunsPath(project: string, environment: string): string;
|
|
2283
|
-
/** `/api/box/envs/<project>/<env>/runs/<runId>`. */
|
|
2284
|
-
declare function boxRunPath(project: string, environment: string, runId: string): string;
|
|
2285
|
-
/** What the viewer asks for. Deliberately not the viewer's own
|
|
2286
|
-
* `RunRequest`: that one carries local concerns (worker counts, debug
|
|
2287
|
-
* flags) the box decides for itself, and a box route that accepted them
|
|
2288
|
-
* would be a second way to configure a run. */
|
|
2289
|
-
interface BoxRunRequest {
|
|
2290
|
-
kind: "collection" | "scenario";
|
|
2291
|
-
/** Collection name, or a scenario ref (`folder/test`). */
|
|
2292
|
-
ref: string;
|
|
2293
|
-
}
|
|
2294
|
-
/** The daemon accepted the ticket. The run has NOT started — on a busy
|
|
2295
|
-
* box it may wait behind a suite for a while, which is the whole point
|
|
2296
|
-
* of there being one queue.
|
|
2297
|
-
*
|
|
2298
|
-
* No ticket name: the queue's file names are the box's own business,
|
|
2299
|
-
* and stopping a run goes back through `DELETE …/runs/<runId>` rather
|
|
2300
|
-
* than through the queue directly. The run id is the only handle a
|
|
2301
|
-
* caller needs, and the only one it is given. */
|
|
2302
|
-
interface BoxRunAccepted {
|
|
2303
|
-
runId: string;
|
|
2304
|
-
acceptedAt: number;
|
|
2305
|
-
}
|
|
2306
|
-
type BoxRunState = "queued" | "running" | "finished";
|
|
2307
|
-
interface BoxRunStatus {
|
|
2308
|
-
runId: string;
|
|
2309
|
-
state: BoxRunState;
|
|
2310
|
-
/** Present once the run ended. `null` when it died on a signal. */
|
|
2311
|
-
exitCode?: number | null;
|
|
2312
|
-
startedAt?: number;
|
|
2313
|
-
finishedAt?: number;
|
|
2314
|
-
}
|
|
2315
|
-
declare function parseBoxRunRequest(value: unknown): BoxRunRequest | null;
|
|
2316
|
-
declare function parseBoxRunAccepted(value: unknown): BoxRunAccepted | null;
|
|
2317
|
-
declare function parseBoxRunStatus(value: unknown): BoxRunStatus | null;
|
|
2318
|
-
|
|
2319
2526
|
declare const WORKSPACE_SCHEMA_VERSION = 1;
|
|
2320
2527
|
/** Written by the host beside the artifacts it manages:
|
|
2321
2528
|
* `<artifactsRoot>/unotest/.workspace.json`. In the artifact tree and
|
|
@@ -2361,6 +2568,25 @@ interface WorkspaceFile {
|
|
|
2361
2568
|
/** Where to POST `{ bundleId }` to switch, relative to the page's own
|
|
2362
2569
|
* origin. Absent when switching is not offered. */
|
|
2363
2570
|
switchPath?: string;
|
|
2571
|
+
/** Present only while a PERSON's selection holds this environment on
|
|
2572
|
+
* its bundle, keeping it from following its branch (`switchedBy` says
|
|
2573
|
+
* who). `path` takes an empty POST that lets go; `branch` is what the
|
|
2574
|
+
* environment follows then. A viewer older than this field ignores it;
|
|
2575
|
+
* a host older than it never writes it — and nothing is offered. */
|
|
2576
|
+
follow?: WorkspaceFollow;
|
|
2577
|
+
/** The box's own version — what its operator sees, not the suite's
|
|
2578
|
+
* `@unotest/web`, which the viewer knows itself and which a customer
|
|
2579
|
+
* used to read as the box's (#229). A host older than the field writes
|
|
2580
|
+
* nothing, and the viewer labels only what it knows. */
|
|
2581
|
+
boxVersion?: string;
|
|
2582
|
+
/** The lowest `@unotest/web` this box runs suites on — the run
|
|
2583
|
+
* contract's floor, raised by the operator's config. A viewer running
|
|
2584
|
+
* on an older one says so. */
|
|
2585
|
+
minWebVersion?: string;
|
|
2586
|
+
}
|
|
2587
|
+
interface WorkspaceFollow {
|
|
2588
|
+
path: string;
|
|
2589
|
+
branch: string;
|
|
2364
2590
|
}
|
|
2365
2591
|
/** Null for anything we cannot trust — a torn write, a newer schema, a
|
|
2366
2592
|
* file that is not ours. Null means "no host", i.e. exactly the local
|
|
@@ -2977,6 +3203,37 @@ declare function replaceEnvVar(content: string, key: string, value: string): {
|
|
|
2977
3203
|
replaced: boolean;
|
|
2978
3204
|
};
|
|
2979
3205
|
|
|
3206
|
+
/** A secret's name and the value that must never be shown. */
|
|
3207
|
+
interface SecretValue {
|
|
3208
|
+
name: string;
|
|
3209
|
+
value: string;
|
|
3210
|
+
}
|
|
3211
|
+
/** What stands where a secret's value was. */
|
|
3212
|
+
declare function secretMark(name: string): string;
|
|
3213
|
+
/** The order masking needs: longest value first, so a secret that is a
|
|
3214
|
+
* substring of another does not mask the longer one partly; empty values
|
|
3215
|
+
* dropped, since they would match everywhere. */
|
|
3216
|
+
declare function orderSecretValues(secrets: Iterable<SecretValue>): SecretValue[];
|
|
3217
|
+
/** `text` with every value of `ordered` (see {@link orderSecretValues})
|
|
3218
|
+
* replaced by its mark. */
|
|
3219
|
+
declare function maskSecretValues(text: string, ordered: readonly SecretValue[]): string;
|
|
3220
|
+
|
|
3221
|
+
interface Version {
|
|
3222
|
+
major: number;
|
|
3223
|
+
minor: number;
|
|
3224
|
+
patch: number;
|
|
3225
|
+
}
|
|
3226
|
+
/** The lowest version a pin admits, or null when the pin says nothing we
|
|
3227
|
+
* can reason about (`*`, `latest`, a git URL, a workspace protocol). Null
|
|
3228
|
+
* means "unknown", and the caller treats unknown as "do not guess". */
|
|
3229
|
+
declare function lowestVersionOf(pin: string): Version | null;
|
|
3230
|
+
declare function compareVersions(a: Version, b: Version): number;
|
|
3231
|
+
/** True when the pin may install something older than the minimum. An
|
|
3232
|
+
* unreadable pin or minimum is NOT below: refusing over a version string
|
|
3233
|
+
* this check cannot read would break a legitimate setup, and a version
|
|
3234
|
+
* that really is too old fails loudly on its own. */
|
|
3235
|
+
declare function isBelowMinimum(pin: string, minimum: string): boolean;
|
|
3236
|
+
|
|
2980
3237
|
/** Which group the user is adding into. App/runner → `.env`, secret →
|
|
2981
3238
|
* `.secrets`. Mirrors VariableCategory as an INPUT (the user's choice). */
|
|
2982
3239
|
type VariableKind = VariableCategory;
|
|
@@ -3662,4 +3919,4 @@ interface CloudApiRouteMatch {
|
|
|
3662
3919
|
*/
|
|
3663
3920
|
declare function matchCloudApiRoute(method: string, path: string): CloudApiRouteMatch | undefined;
|
|
3664
3921
|
|
|
3665
|
-
export { ACTOR_TICKET_HEADER, ARTIFACTS_ROOT_ENV, type AddVariablePlan, type AddVariablePlanInput, type AppPathPickerSpec, type AppServerEvent, type ApprovalAction, type ApprovalPrice, type AuthoringRunRequest, BLOBS_DIR, BOX_DELETE_CONSEQUENCE, BOX_ENV_VALUES_SEGMENT, BOX_NOTIFY_CHANNEL_KINDS, BOX_NOTIFY_EVENTS, BOX_NOTIFY_PATH, BOX_NOTIFY_STATES, BOX_NOTIFY_TRIGGER_KINDS, BOX_PUSH_TOKEN_PREFIX, BOX_READ_ENVIRONMENTS_PATH, BOX_READ_ENVIRONMENT_HEADER, BOX_READ_TOKEN_ENV, BOX_READ_TOKEN_PREFIX, BOX_REVEAL_SEGMENT, BOX_REVOCATIONS_RETRY_AFTER_SECONDS, BOX_RUNS_SEGMENT, BOX_SECRET_NAMES_ENV, BOX_SIGNED_TOKEN, BOX_SIGNED_TOKEN_PREFIX, BOX_TOKEN_ENV, BOX_URL_ENV, BOX_VALUES_PATH, BOX_VARIABLE_NAMES_ENV, BROWSER_CHANNEL_ENV, BROWSER_ENV, BUNDLED_BROWSER_CHANNEL, BUNDLE_ID_ENV, BUNDLE_MANIFEST_FILE, BUNDLE_SCHEMA_VERSION, BUNDLE_UPLOAD_PATH, type BoxEnvValuesReplaceRequest, type BoxEnvValuesView, type BoxNotifyChanged, type BoxNotifyChannelKind, type BoxNotifyChannelView, type BoxNotifyChannelWrite, type BoxNotifyEnabledPatch, type BoxNotifyError, type BoxNotifyErrorCode, type BoxNotifyEvent, type BoxNotifyLastDelivery, type BoxNotifyMute, type BoxNotifyMuteScope, type BoxNotifyMuteWrite, type BoxNotifyPreview, type BoxNotifyProjectView, type BoxNotifyQuietHours, type BoxNotifyQuietHoursWrite, type BoxNotifyRule, type BoxNotifyRuleWrite, type BoxNotifySecret, type BoxNotifySeriesEntry, type BoxNotifySeriesView, type BoxNotifyState, type BoxNotifyTestResult, type BoxNotifyTriggerKind, type BoxNotifyView, type BoxReadEnvironment, type BoxReadErrorBody, type BoxReadErrorCode, type BoxReadInstall, type BoxRunAccepted, type BoxRunRequest, type BoxRunState, type BoxRunStatus, type BoxSecretRevealResponse, type BoxSecretsRevealResponse, type BoxValueChanged, type BoxValueKind, type BoxValueSetRequest, type BoxValuesError, type BoxValuesErrorCode, type BoxValuesReplaceRequest, type BoxValuesReplaced, type BoxValuesResponse, type BreakpointEntry, type BreakpointsFile, type BundleGitInfo, type BundleManifest, type BundleScopeMismatch, type BundleUploadError, type BundleUploadErrorCode, type BundleUploadErrorDetail, type BundleUploadOk, type BundleUploadResponse, type BundleUploadStatus, type BundleVariableGap, CI_RUN_PATH, CLOUD_API_ROUTES, COLLECTIONS_SUBDIR, COLLECTION_NAME_FORBIDDEN_RE, COMMANDS_FILE, type CheckSeverity, type CiProviderId, type CiQueuedRun, type CiRunAccepted, type CiRunError, type CiRunErrorCode, type CiRunRequest, type CiRunResponse, type CloudApiRoute, type CloudApiRouteMatch, type CollectionMeta, type CollectionRunArtifact, type CollectionRunFinishedEvent, type CollectionRunRequest, type CollectionRunStartedEvent, type CollectionRunTab, type CollectionScenarioFinishedEvent, type CollectionScenarioStartedEvent, type CollectionScheduleEntry, type CollectionTab, type ContextTagged, DAY_INDEX_FILE, DAY_SHORT, DEFAULT_COLLECTION_NAME, type DbgCommand, type DbgCommandAbort, type DbgCommandClearBp, type DbgCommandContinue, type DbgCommandKind, type DbgCommandPause, type DbgCommandPickerStart, type DbgCommandPickerStop, type DbgCommandProbe, type DbgCommandRecord, type DbgCommandSetBp, type DbgCommandSnapshot, type DbgCommandStep, type DbgCommandWheel, type DebugCapabilities, type DoctorCheck, type DoctorContext, type DownloadEvent, type DslDiagnostic, type DslValidateContext, type DslVocabArg, type DslVocabCategory, type DslVocabEntry, E2E_SUBDIR, ENV_FILE, EXPECT_FAIL_ANNOTATION, type EnqueueRunInput, type EnvChangedMessage, type EnvFile, type EnvUpdate, type EnvVar, type ErrorMessage, FAILURES_DIR_SEGMENTS, FAILURES_ROOT_ENV, FREQ_FIELDS, type FailureBundleWrittenEvent, type FirstRunCommandInput, type FsBreakpointsChangedMessage, type FsCollectionRunStepMessage, type FsCollectionsChangedMessage, type FsHelpersChangedMessage, type FsRunFinishedMessage, type FsRunStartedMessage, type FsRunStepMessage, type FsScenariosChangedMessage, GUARD_SECRET_HEADER, HEARTBEAT_FILE, HELPERS_SUBDIR, type HelperMeta, type HelperTab, type HostRequirement, type IDslLanguageService, type ILaunchedProcess, type IProcessLauncher, type IRunQueue, type IRunnerAdapter, InvalidBlobHashError, JUDGE_ENV, JUDGE_ROUTES, type JudgeErrorResponse, type JudgeHealthResponse, type JudgeRequest, type JudgeVerdict, type JudgeVerdictEvent, LOCK_FILE, LOG_FILE, type LaunchSpec, type LocatorPickedEvent, type LockFile, type LogEvent, type LogLineMessage, type LoopIterationEvent, type Matcher, type NoteEvent, type OverviewTab, PICKER_INCLUDED_TEXT, PICKER_SNAPSHOT_FILE, type ParsedTicketName, type PausedEvent, type PickerMode, type ProbeMatch, type ProbePinned, type ProbeResult, type ProbeResultEvent, QUEUE_DISABLED_ENV, QUEUE_GLOBAL_DIR_ENV, QUEUE_GLOBAL_SLOTS_ENV, QUEUE_LEASE_ENV, QUEUE_MUTEX_FILE, QUEUE_PRIORITIES, QUEUE_RUNNING_DIR, QUEUE_SCHEMA_VERSION, QUEUE_SLOTS_DIR, QUEUE_SUBDIR, QUEUE_TICKETS_DIR, type QueueChangedMessage, type QueueEntry, type QueuePoolState, type QueuePriority, type QueueProducer, type QueueProducerKind, type QueueSnapshot, type QueueTicket, type QueueTicketCi, type QueueTicketKind, type QueueTicketSource, RUNNER_CONFIG_KEYS, RUNNER_SETTING_PREFIX, RUNS_SUBDIR, RUNTIME_FILE, RUN_ACTOR_ENV, RUN_INDEX_SCHEMA_VERSION, RUN_MANIFEST_FILE, RUN_SOURCES_FILE, RUN_TRIGGER_ENV, type RecordedActionKind, type RegexLiteral, type ResumedEvent, type RunArtifact, type RunFinishedEvent, type RunId, type RunIndexEntry, type RunIndexHeader, type RunKind, type RunManifest, type RunMeta, type RunOutcome, type RunQueueLease, type RunQueueTicketHandle, type RunRequest, type RunSources, type RunStartedEvent, type RunStatus, type RunTrigger, type RunTriggerKind, RunnerAdapterNotFoundError, RunnerNotConfiguredError, type RuntimeState, type RuntimeStateFile, SCENARIOS_INDEX_DIR, SCENARIOS_LATEST_FILE, SCENARIO_RECENT_WINDOW, SCHEDULES_FILE, SCHEDULES_FINGERPRINT_ENV, SECRETS_FILE, SEGMENT_NAME_FORBIDDEN_RE, SNAPSHOTS_SUBDIR, STDERR_FILE, STDOUT_FILE, STEPS_FILE, type ScenarioAnnotations, type ScenarioLatestEntry, type ScenarioMeta, type ScenarioRunRequest, type ScenarioRunTab, type ScenarioScheduleEntry, type ScenarioTab, type ScenariosLatest, type ScenariosPayload, type ScheduleEntry, type ScheduleFreq, type ScheduleSpec, type ScreenshotEvent, type SnapshotTab, type SoftFailureRecord, type StepBlockFinishedEvent, type StepBlockStartedEvent, type StepFailEvent, type StepOkEvent, type StepPosition, type StepStartedEvent, TARGET_ENV_VAR, TERMINAL_RUNTIME_STATES, TERMINAL_WS_EVENT, type TabKind, type TabKindName, type TeardownFailureRecord, type TeardownFinishedEvent, type TeardownSkippedEvent, type TeardownStartedEvent, type TeardownStateRecord, type TerminalClientMessage, type TerminalCloseMessage, type TerminalDataMessage, type TerminalErrorMessage, type TerminalExitMessage, type TerminalKind, type TerminalOutputMessage, type TerminalResizeMessage, type TerminalServerMessage, type TerminalSpawnMessage, type ToolCallEvent, type ToolResultEvent, UNOTEST_DIR, UnplaceableRunIdError, UnsupportedRunKindError, type VariableCategory, type VariableKind, type VariablePlanError, type VisualAssertEvent, type VisualFailureRecord, WEEK_CHIP_ORDER, WORKSPACE_FILE, WORKSPACE_SCHEMA_VERSION, type WheelChangedEvent, type WorkspaceBundle, type WorkspaceFile, type WsMessage, type WsMessageKind, activeEnvName, approvalActionText, approvalConsequence, approvalPrice, approvalPriceLabel, artifactsRootFrom, blobPathFor, blobRelPathFor, blobRelSegmentsFor, blobsRootFor, boxEnvSecretRevealPath, boxEnvSecretsRevealPath, boxEnvValuePath, boxEnvValuesPath, boxNotifyChannelPath, boxNotifyMutePath, boxNotifyPreviewPath, boxNotifyPreviewTrigger, boxNotifyProjectPath, boxNotifyQuietHoursPath, boxNotifyRulePath, boxNotifySeriesPath, boxNotifySeriesResetPath, boxNotifyTestPath, boxRunPath, boxRunsPath, boxValueKindOfSegment, boxValuePath, boxValuesPath, canonicalScheduleSet, categorizeVariable, compareQueueTicketNames, cronFromSpec, debugDirFor, debuggerFileFor, declaredEnvKeys, decodeNameList, deleteShadowWarning, describeBundle, describeCron, describeSpec, describeTicketCi, encodeNameList, envFileFor, envKeys, envLayerFilesFor, envNamesFromDirListing, failuresRootFrom, failuresRootIn, failuresRootUnder, firstRunCommand, foldScenarioRun, formatNextTick, insertEnvVar, isAnnotationLine, isBoxNotifyState, isEnvVarName, isExternalVarName, isFailingStatus, isQueueDirName, isRecord, isRegexLiteral, isRunnerConfigKey, isRunnerSetting, isRunsDirName, isTerminalRuntimeState, makeQueueTicketName, makeRunId, manifestTrigger, matchCloudApiRoute, mergeSchedules, nextTickFromSpec, parseAppServerEvent, parseBoxEnvValuesReplaceRequest, parseBoxNotifyChanged, parseBoxNotifyError, parseBoxNotifyMuteScope, parseBoxNotifyPreview, parseBoxNotifyProjectView, parseBoxNotifySeriesView, parseBoxNotifyTestResult, parseBoxNotifyView, parseBoxReadEnvironments, parseBoxReadError, parseBoxReadInstall, parseBoxRunAccepted, parseBoxRunRequest, parseBoxRunStatus, parseBoxSecretRevealResponse, parseBoxSecretsRevealResponse, parseBoxValueSetRequest, parseBoxValuesReplaceRequest, parseBoxValuesResponse, parseBundleManifest, parseBundleUploadResponse, parseCiProvider, parseCiRunRequest, parseCiRunResponse, parseEnvContent, parseQueueTicket, parseQueueTicketName, parseScenarioAnnotations, parseScheduleEntry, parseSchedulesDoc, parseSchedulesJson, parseWorkspaceFile, planAddVariable, projectQueueRoot, projectRunDirFor, projectRunsRoot, queueDirFor, queuePriorityFromRank, queuePriorityRank, regexLiteral, removeEnvVar, replaceEnvVar, requireRunDirFor, reservedBoxValueNames, runDirFor, runIdStartedAt, runTriggerEnv, runTriggerFromEnv, runsDirFor, sanitizeRunIdSegment, scenarioIndexFileName, scenarioRefFromFileName, scheduleTarget, secretsFileFor, secretsLayerFilesFor, serializeEnvValue, shardDaysDescending, shardDirFor, shardPathForRunId, shardPathForTimestamp, specFromCron, testDirFor, validateCollectionName, validateSegmentName };
|
|
3922
|
+
export { ACTOR_TICKET_HEADER, ARTIFACTS_ROOT_ENV, type AddVariablePlan, type AddVariablePlanInput, type AppPathPickerSpec, type AppServerEvent, type ApprovalAction, type ApprovalPrice, type AuthoringRunRequest, BLOBS_DIR, BOX_DELETE_CONSEQUENCE, BOX_ENV_VALUES_SEGMENT, BOX_NOTIFY_CHANNEL_KINDS, BOX_NOTIFY_EVENTS, BOX_NOTIFY_PATH, BOX_NOTIFY_STATES, BOX_NOTIFY_TRIGGER_KINDS, BOX_PUSH_TOKEN_PREFIX, BOX_READ_ENVIRONMENTS_PATH, BOX_READ_ENVIRONMENT_HEADER, BOX_READ_TOKEN_ENV, BOX_READ_TOKEN_PREFIX, BOX_REVEAL_SEGMENT, BOX_REVOCATIONS_RETRY_AFTER_SECONDS, BOX_RUNS_SEGMENT, BOX_SECRET_NAMES_ENV, BOX_SIGNED_TOKEN, BOX_SIGNED_TOKEN_PREFIX, BOX_TOKEN_ENV, BOX_URL_ENV, BOX_VALUES_PATH, BOX_VARIABLE_NAMES_ENV, BROWSER_CHANNEL_ENV, BROWSER_ENV, BUNDLED_BROWSER_CHANNEL, BUNDLE_ID_ENV, BUNDLE_MANIFEST_FILE, BUNDLE_SCHEMA_VERSION, BUNDLE_UPLOAD_PATH, type BoxEnvValuesReplaceRequest, type BoxEnvValuesView, type BoxNotifyChanged, type BoxNotifyChannelKind, type BoxNotifyChannelView, type BoxNotifyChannelWrite, type BoxNotifyEnabledPatch, type BoxNotifyError, type BoxNotifyErrorCode, type BoxNotifyEvent, type BoxNotifyLastDelivery, type BoxNotifyMute, type BoxNotifyMuteScope, type BoxNotifyMuteWrite, type BoxNotifyPreview, type BoxNotifyProjectView, type BoxNotifyQuietHours, type BoxNotifyQuietHoursWrite, type BoxNotifyRule, type BoxNotifyRuleWrite, type BoxNotifySecret, type BoxNotifySeriesEntry, type BoxNotifySeriesView, type BoxNotifyState, type BoxNotifyTestResult, type BoxNotifyTriggerKind, type BoxNotifyView, type BoxReadEnvironment, type BoxReadErrorBody, type BoxReadErrorCode, type BoxReadInstall, type BoxRunAccepted, type BoxRunRequest, type BoxRunState, type BoxRunStatus, type BoxSecretRevealResponse, type BoxSecretsRevealResponse, type BoxValueChanged, type BoxValueKind, type BoxValueNames, type BoxValueSetRequest, type BoxValuesError, type BoxValuesErrorCode, type BoxValuesMergeRequest, type BoxValuesMerged, type BoxValuesReplaceRequest, type BoxValuesReplaced, type BoxValuesResponse, type BreakpointEntry, type BreakpointsFile, type BundleGitInfo, type BundleManifest, type BundleRemoveError, type BundleRemoveErrorCode, type BundleRemoveErrorDetail, type BundleRemoveOk, type BundleRemoveRequest, type BundleRemoveResponse, type BundleRemoved, type BundleScopeMismatch, type BundleSwitching, type BundleUnmappedRepo, type BundleUploadError, type BundleUploadErrorCode, type BundleUploadErrorDetail, type BundleUploadOk, type BundleUploadResponse, type BundleUploadStatus, type BundleUse, type BundleVariableGap, CI_RUNS_PATH, CI_RUN_LINES_AFTER, CI_RUN_LINES_MAX, CI_RUN_PATH, CLOUD_API_ROUTES, COLLECTIONS_SUBDIR, COLLECTION_NAME_FORBIDDEN_RE, COMMANDS_FILE, type CheckSeverity, type CiProviderId, type CiQueuedRun, type CiRunAccepted, type CiRunError, type CiRunErrorCode, type CiRunLine, type CiRunLines, type CiRunLinesResponse, type CiRunRequest, type CiRunResponse, type CiRunStatusError, type CiRunStatusErrorCode, type CiRunStatusResponse, type CloudApiRoute, type CloudApiRouteMatch, type CollectionMeta, type CollectionRunArtifact, type CollectionRunFinishedEvent, type CollectionRunRequest, type CollectionRunStartedEvent, type CollectionRunTab, type CollectionScenarioFinishedEvent, type CollectionScenarioStartedEvent, type CollectionScheduleEntry, type CollectionTab, type ContextTagged, DAY_INDEX_FILE, DAY_SHORT, DEFAULT_COLLECTION_NAME, type DbgCommand, type DbgCommandAbort, type DbgCommandClearBp, type DbgCommandContinue, type DbgCommandKind, type DbgCommandPause, type DbgCommandPickerStart, type DbgCommandPickerStop, type DbgCommandProbe, type DbgCommandRecord, type DbgCommandSetBp, type DbgCommandSnapshot, type DbgCommandStep, type DbgCommandWheel, type DebugCapabilities, type DoctorCheck, type DoctorContext, type DownloadEvent, type DslDiagnostic, type DslValidateContext, type DslVocabArg, type DslVocabCategory, type DslVocabEntry, E2E_SUBDIR, ENV_FILE, EXPECT_FAIL_ANNOTATION, type EnqueueRunInput, type EnvChangedMessage, type EnvFile, type EnvUpdate, type EnvVar, type ErrorMessage, FAILURES_DIR_SEGMENTS, FAILURES_ROOT_ENV, FREQ_FIELDS, type FailureBundleWrittenEvent, type FirstRunCommandInput, type FsBreakpointsChangedMessage, type FsCollectionRunStepMessage, type FsCollectionsChangedMessage, type FsHelpersChangedMessage, type FsRunFinishedMessage, type FsRunStartedMessage, type FsRunStepMessage, type FsScenariosChangedMessage, GUARD_SECRET_HEADER, HEARTBEAT_FILE, HELPERS_SUBDIR, type HelperMeta, type HelperTab, type HostRequirement, type IDslLanguageService, type ILaunchedProcess, type IProcessLauncher, type IRunQueue, type IRunnerAdapter, InvalidBlobHashError, JUDGE_ENV, JUDGE_ROUTES, type JudgeErrorResponse, type JudgeHealthResponse, type JudgeRequest, type JudgeVerdict, type JudgeVerdictEvent, LOCK_FILE, LOG_FILE, type LaunchSpec, type LocatorPickedEvent, type LockFile, type LogEvent, type LogLineMessage, type LoopIterationEvent, type Matcher, type NoteEvent, type OverviewTab, PICKER_INCLUDED_TEXT, PICKER_SNAPSHOT_FILE, type ParsedTicketName, type PausedEvent, type PickerMode, type ProbeMatch, type ProbePinned, type ProbeResult, type ProbeResultEvent, QUEUE_DISABLED_ENV, QUEUE_GLOBAL_DIR_ENV, QUEUE_GLOBAL_SLOTS_ENV, QUEUE_LEASE_ENV, QUEUE_MUTEX_FILE, QUEUE_PRIORITIES, QUEUE_RUNNING_DIR, QUEUE_SCHEMA_VERSION, QUEUE_SLOTS_DIR, QUEUE_SUBDIR, QUEUE_TICKETS_DIR, type QueueChangedMessage, type QueueEntry, type QueuePoolState, type QueuePriority, type QueueProducer, type QueueProducerKind, type QueueSnapshot, type QueueTicket, type QueueTicketCi, type QueueTicketKind, type QueueTicketSource, RUNNER_CONFIG_KEYS, RUNNER_SETTING_PREFIX, RUNS_SUBDIR, RUNTIME_FILE, RUN_ACTOR_ENV, RUN_INDEX_SCHEMA_VERSION, RUN_MANIFEST_FILE, RUN_SOURCES_FILE, RUN_TRIGGER_ENV, type RecordedActionKind, type RegexLiteral, type ResumedEvent, type RunArtifact, type RunFinishedEvent, type RunId, type RunIndexEntry, type RunIndexHeader, type RunKind, type RunManifest, type RunMeta, type RunOutcome, type RunQueueLease, type RunQueueTicketHandle, type RunRequest, type RunSources, type RunStartedEvent, type RunStatus, type RunTrigger, type RunTriggerKind, RunnerAdapterNotFoundError, RunnerNotConfiguredError, type RuntimeState, type RuntimeStateFile, SCENARIOS_INDEX_DIR, SCENARIOS_LATEST_FILE, SCENARIO_RECENT_WINDOW, SCHEDULES_FILE, SCHEDULES_FINGERPRINT_ENV, SECRETS_FILE, SEGMENT_NAME_FORBIDDEN_RE, SNAPSHOTS_SUBDIR, STDERR_FILE, STDOUT_FILE, STEPS_FILE, type ScenarioAnnotations, type ScenarioLatestEntry, type ScenarioMeta, type ScenarioRunRequest, type ScenarioRunTab, type ScenarioScheduleEntry, type ScenarioTab, type ScenariosLatest, type ScenariosPayload, type ScheduleEntry, type ScheduleFreq, type ScheduleSpec, type ScreenshotEvent, type SecretValue, type SnapshotTab, type SoftFailureRecord, type StepBlockFinishedEvent, type StepBlockStartedEvent, type StepFailEvent, type StepOkEvent, type StepPosition, type StepStartedEvent, TARGET_ENV_VAR, TERMINAL_RUNTIME_STATES, TERMINAL_WS_EVENT, type TabKind, type TabKindName, type TeardownFailureRecord, type TeardownFinishedEvent, type TeardownSkippedEvent, type TeardownStartedEvent, type TeardownStateRecord, type TerminalClientMessage, type TerminalCloseMessage, type TerminalDataMessage, type TerminalErrorMessage, type TerminalExitMessage, type TerminalKind, type TerminalOutputMessage, type TerminalResizeMessage, type TerminalServerMessage, type TerminalSpawnMessage, type ToolCallEvent, type ToolResultEvent, UNOTEST_DIR, type UnknownEnvironmentDetail, UnplaceableRunIdError, UnsupportedRunKindError, type VariableCategory, type VariableKind, type VariablePlanError, type Version, type VisualAssertEvent, type VisualFailureRecord, WEEK_CHIP_ORDER, WORKSPACE_FILE, WORKSPACE_SCHEMA_VERSION, type WheelChangedEvent, type WorkspaceBundle, type WorkspaceFile, type WorkspaceFollow, type WsMessage, type WsMessageKind, activeEnvName, approvalActionText, approvalConsequence, approvalPrice, approvalPriceLabel, artifactsRootFrom, blobPathFor, blobRelPathFor, blobRelSegmentsFor, blobsRootFor, boxEnvSecretRevealPath, boxEnvSecretsRevealPath, boxEnvValuePath, boxEnvValuesPath, boxNotifyChannelPath, boxNotifyMutePath, boxNotifyPreviewPath, boxNotifyPreviewTrigger, boxNotifyProjectPath, boxNotifyQuietHoursPath, boxNotifyRulePath, boxNotifySeriesPath, boxNotifySeriesResetPath, boxNotifyTestPath, boxRunPath, boxRunsPath, boxValueKindOfSegment, boxValuePath, boxValuesPath, canonicalScheduleSet, categorizeVariable, ciRunLinesPath, compareQueueTicketNames, compareVersions, cronFromSpec, debugDirFor, debuggerFileFor, declaredEnvKeys, decodeNameList, deleteShadowWarning, describeBundle, describeCron, describeSpec, describeTicketCi, encodeNameList, envFileFor, envKeys, envLayerFilesFor, envNamesFromDirListing, failuresRootFrom, failuresRootIn, failuresRootUnder, firstRunCommand, foldScenarioRun, formatNextTick, insertEnvVar, isAnnotationLine, isBelowMinimum, isBoxNotifyState, isEnvVarName, isExternalVarName, isFailingStatus, isQueueDirName, isRecord, isRegexLiteral, isRunId, isRunnerConfigKey, isRunnerSetting, isRunsDirName, isTerminalRuntimeState, lowestVersionOf, makeQueueTicketName, makeRunId, manifestTrigger, maskSecretValues, matchCloudApiRoute, mergeSchedules, nextTickFromSpec, orderSecretValues, parseAppServerEvent, parseBoxEnvValuesReplaceRequest, parseBoxNotifyChanged, parseBoxNotifyError, parseBoxNotifyMuteScope, parseBoxNotifyPreview, parseBoxNotifyProjectView, parseBoxNotifySeriesView, parseBoxNotifyTestResult, parseBoxNotifyView, parseBoxReadEnvironments, parseBoxReadError, parseBoxReadInstall, parseBoxRunAccepted, parseBoxRunRequest, parseBoxRunStatus, parseBoxSecretRevealResponse, parseBoxSecretsRevealResponse, parseBoxValueSetRequest, parseBoxValuesMergeRequest, parseBoxValuesReplaceRequest, parseBoxValuesResponse, parseBundleManifest, parseBundleRemoveRequest, parseBundleRemoveResponse, parseBundleUploadResponse, parseCiProvider, parseCiRunLinesResponse, parseCiRunRequest, parseCiRunResponse, parseCiRunStatusResponse, parseEnvContent, parseQueueTicket, parseQueueTicketName, parseScenarioAnnotations, parseScheduleEntry, parseSchedulesDoc, parseSchedulesJson, parseUnknownEnvironmentDetail, parseWorkspaceFile, planAddVariable, projectQueueRoot, projectRunDirFor, projectRunsRoot, queueDirFor, queuePriorityFromRank, queuePriorityRank, regexLiteral, removeEnvVar, replaceEnvVar, requireRunDirFor, reservedBoxValueNames, runDirFor, runIdStartedAt, runTriggerEnv, runTriggerFromEnv, runsDirFor, sanitizeRunIdSegment, scenarioIndexFileName, scenarioRefFromFileName, scheduleTarget, secretMark, secretsFileFor, secretsLayerFilesFor, serializeEnvValue, shardDaysDescending, shardDirFor, shardPathForRunId, shardPathForTimestamp, specFromCron, testDirFor, validateCollectionName, validateSegmentName };
|