@qawolf/api-contracts 0.73.0 → 0.74.0

package/dist/v1/run/getAttemptArtifacts.js

@@ -0,0 +1,78 @@
+import { z } from "zod";
+import { publicRunStatusValues, publicRunSummaryStatusValues, } from "./summary.js";
+export const makeGetRunAttemptArtifactsContract = (ids) => {
+    const input = z.object({ attemptId: ids.runAttempt });
+    const attemptStatus = z.enum([
+        "passed",
+        "failed",
+        "canceled",
+        "aborted",
+        "skipped",
+    ]);
+    const attemptNeighbor = z.object({
+        attemptId: ids.runAttempt,
+        status: attemptStatus,
+    });
+    const response = z.object({
+        flowId: ids.flow,
+        flowStatus: z.enum(publicRunStatusValues),
+        retryContext: z.object({
+            currentOrdinal: z.number().int().min(1),
+            next: attemptNeighbor.optional(),
+            previous: attemptNeighbor.optional(),
+            total: z.number().int().min(1),
+        }),
+        runId: ids.run,
+        runStatus: z.enum(publicRunSummaryStatusValues),
+    });
+    const attempt = z.object({
+        attemptId: ids.runAttempt,
+        completedAt: z.iso.datetime().optional(),
+        createdAt: z.iso.datetime(),
+        error: z.string().optional(),
+        startedAt: z.iso.datetime().optional(),
+    });
+    const output = z.discriminatedUnion("artifactStatus", [
+        response.extend({
+            artifacts: z.object({
+                logsUrl: z.url().optional(),
+                traceUrl: z.url().optional(),
+                videoUrl: z.url().optional(),
+            }),
+            artifactStatus: z.literal("signed"),
+            attempt: attempt.extend({
+                kind: z.literal("automated"),
+                status: attemptStatus,
+            }),
+        }),
+        response.extend({
+            artifacts: z.object({}).strict(),
+            artifactStatus: z.literal("signing-failed"),
+            attempt: attempt.extend({
+                kind: z.literal("automated"),
+                status: attemptStatus,
+            }),
+        }),
+        response.extend({
+            artifacts: z.object({}).strict(),
+            artifactStatus: z.literal("not-captured"),
+            attempt: attempt.extend({
+                kind: z.literal("manual"),
+                status: z.literal("passed"),
+            }),
+        }),
+    ]);
+    return {
+        annotations: {
+            destructiveHint: false,
+            openWorldHint: false,
+            readOnlyHint: true,
+        },
+        description: "Get metadata and signed artifact URLs for one finished run attempt.",
+        input,
+        kind: "read",
+        name: "run.getAttemptArtifacts",
+        output,
+    };
+};
+//# sourceMappingURL=getAttemptArtifacts.js.map

package/dist/v1/run/getAttemptArtifacts.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"getAttemptArtifacts.js","sourceRoot":"","sources":["../../../src/v1/run/getAttemptArtifacts.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAKxB,OAAO,EACL,qBAAqB,EACrB,4BAA4B,GAC7B,MAAM,cAAc,CAAC;AAEtB,MAAM,CAAC,MAAM,kCAAkC,GAAG,CAIhD,GAID,EAAE,EAAE;IACH,MAAM,KAAK,GAAG,CAAC,CAAC,MAAM,CAAC,EAAE,SAAS,EAAE,GAAG,CAAC,UAAU,EAAE,CAAC,CAAC;IACtD,MAAM,aAAa,GAAG,CAAC,CAAC,IAAI,CAAC;QAC3B,QAAQ;QACR,QAAQ;QACR,UAAU;QACV,SAAS;QACT,SAAS;KACV,CAAC,CAAC;IACH,MAAM,eAAe,GAAG,CAAC,CAAC,MAAM,CAAC;QAC/B,SAAS,EAAE,GAAG,CAAC,UAAU;QACzB,MAAM,EAAE,aAAa;KACtB,CAAC,CAAC;IACH,MAAM,QAAQ,GAAG,CAAC,CAAC,MAAM,CAAC;QACxB,MAAM,EAAE,GAAG,CAAC,IAAI;QAChB,UAAU,EAAE,CAAC,CAAC,IAAI,CAAC,qBAAqB,CAAC;QACzC,YAAY,EAAE,CAAC,CAAC,MAAM,CAAC;YACrB,cAAc,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC;YACvC,IAAI,EAAE,eAAe,CAAC,QAAQ,EAAE;YAChC,QAAQ,EAAE,eAAe,CAAC,QAAQ,EAAE;YACpC,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC;SAC/B,CAAC;QACF,KAAK,EAAE,GAAG,CAAC,GAAG;QACd,SAAS,EAAE,CAAC,CAAC,IAAI,CAAC,4BAA4B,CAAC;KAChD,CAAC,CAAC;IACH,MAAM,OAAO,GAAG,CAAC,CAAC,MAAM,CAAC;QACvB,SAAS,EAAE,GAAG,CAAC,UAAU;QACzB,WAAW,EAAE,CAAC,CAAC,GAAG,CAAC,QAAQ,EAAE,CAAC,QAAQ,EAAE;QACxC,SAAS,EAAE,CAAC,CAAC,GAAG,CAAC,QAAQ,EAAE;QAC3B,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;QAC5B,SAAS,EAAE,CAAC,CAAC,GAAG,CAAC,QAAQ,EAAE,CAAC,QAAQ,EAAE;KACvC,CAAC,CAAC;IACH,MAAM,MAAM,GAAG,CAAC,CAAC,kBAAkB,CAAC,gBAAgB,EAAE;QACpD,QAAQ,CAAC,MAAM,CAAC;YACd,SAAS,EAAE,CAAC,CAAC,MAAM,CAAC;gBAClB,OAAO,EAAE,CAAC,CAAC,GAAG,EAAE,CAAC,QAAQ,EAAE;gBAC3B,QAAQ,EAAE,CAAC,CAAC,GAAG,EAAE,CAAC,QAAQ,EAAE;gBAC5B,QAAQ,EAAE,CAAC,CAAC,GAAG,EAAE,CAAC,QAAQ,EAAE;aAC7B,CAAC;YACF,cAAc,EAAE,CAAC,CAAC,OAAO,CAAC,QAAQ,CAAC;YACnC,OAAO,EAAE,OAAO,CAAC,MAAM,CAAC;gBACtB,IAAI,EAAE,CAAC,CAAC,OAAO,CAAC,WAAW,CAAC;gBAC5B,MAAM,EAAE,aAAa;aACtB,CAAC;SACH,CAAC;QACF,QAAQ,CAAC,MAAM,CAAC;YACd,SAAS,EAAE,CAAC,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC,MAAM,EAAE;YAChC,cAAc,EAAE,CAAC,CAAC,OAAO,CAAC,gBAAgB,CAAC;YAC3C,OAAO,EAAE,OAAO,CAAC,MAAM,CAAC;gBACtB,IAAI,EAAE,CAAC,CAAC,OAAO,CAAC,WAAW,CAAC;gBAC5B,MAAM,EAAE,aAAa;aACtB,CAAC;SACH,CAAC;QACF,QAAQ,CAAC,MAAM,CAAC;YACd,SAAS,EAAE,CAAC,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC,MAAM,EAAE;YAChC,cAAc,EAAE,CAAC,CAAC,OAAO,CAAC,cAAc,CAAC;YACzC,OAAO,EAAE,OAAO,CAAC,MAAM,CAAC;gBACtB,IAAI,EAAE,CAAC,CAAC,OAAO,CAAC,QAAQ,CAAC;gBACzB,MAAM,EAAE,CAAC,CAAC,OAAO,CAAC,QAAQ,CAAC;aAC5B,CAAC;SACH,CAAC;KACH,CAAC,CAAC;IAEH,OAAO;QACL,WAAW,EAAE;YACX,eAAe,EAAE,KAAK;YACtB,aAAa,EAAE,KAAK;YACpB,YAAY,EAAE,IAAI;SACnB;QACD,WAAW,EACT,qEAAqE;QACvE,KAAK;QACL,IAAI,EAAE,MAAM;QACZ,IAAI,EAAE,yBAAyB;QAC/B,MAAM;KAMP,CAAC;AACJ,CAAC,CAAC"}

package/dist/v1/run/summary.d.ts

@@ -2,6 +2,13 @@ import { z } from "zod";
 import type { PublicIdSchema } from "../ids.js";
 /** The public status vocabulary, shared by a run and by each of its flows. */
 export declare const publicRunStatusValues: readonly ["queued", "running", "passed", "failed", "canceled"];
+/**
+ * The run's own status vocabulary: the flow values plus the states only a
+ * whole run can be in. The deployment verdict's runs share it, so the two
+ * cannot disagree about a run; flow statuses and the `flowStatuses` filter
+ * keep the five shared values.
+ */
+export declare const publicRunSummaryStatusValues: readonly ["queued", "running", "passed", "failed", "canceled", "superseded"];
 export declare const makeRunSummaryFields: <RunId extends PublicIdSchema>(ids: {
     run: RunId;
 }) => {
@@ -21,6 +28,11 @@ export declare const makeRunSummaryFields: <RunId extends PublicIdSchema>(ids: {
         running: "running";
         passed: "passed";
         canceled: "canceled";
+        superseded: "superseded";
     }>;
+    supersededBy: z.ZodOptional<z.ZodObject<{
+        runId: RunId;
+        url: z.ZodURL;
+    }, z.core.$strip>>;
 };
 //# sourceMappingURL=summary.d.ts.map

package/dist/v1/run/summary.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"summary.d.ts","sourceRoot":"","sources":["../../../src/v1/run/summary.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,WAAW,CAAC;AAEhD,8EAA8E;AAC9E,eAAO,MAAM,qBAAqB,gEAMxB,CAAC;AAKX,eAAO,MAAM,oBAAoB,GAAI,KAAK,SAAS,cAAc,EAAE,KAAK;IACtE,GAAG,EAAE,KAAK,CAAC;CACZ;;;;;;;;;;;;;;;;;;CAwCC,CAAC"}
+{"version":3,"file":"summary.d.ts","sourceRoot":"","sources":["../../../src/v1/run/summary.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,WAAW,CAAC;AAEhD,8EAA8E;AAC9E,eAAO,MAAM,qBAAqB,gEAMxB,CAAC;AAEX;;;;;GAKG;AACH,eAAO,MAAM,4BAA4B,8EAG/B,CAAC;AAKX,eAAO,MAAM,oBAAoB,GAAI,KAAK,SAAS,cAAc,EAAE,KAAK;IACtE,GAAG,EAAE,KAAK,CAAC;CACZ;;;;;;;;;;;;;;;;;;;;;;;CAiDC,CAAC"}

package/dist/v1/run/summary.js

@@ -7,6 +7,16 @@ export const publicRunStatusValues = [
     "failed",
     "canceled",
 ];
+/**
+ * The run's own status vocabulary: the flow values plus the states only a
+ * whole run can be in. The deployment verdict's runs share it, so the two
+ * cannot disagree about a run; flow statuses and the `flowStatuses` filter
+ * keep the five shared values.
+ */
+export const publicRunSummaryStatusValues = [
+    ...publicRunStatusValues,
+    "superseded",
+];
 // The shared run summary fields. run.find returns them as rows. run.get adds
 // the per-flow results to them. Both shapes come from this one factory, so
 // the shapes cannot become different.
@@ -40,7 +50,14 @@ export const makeRunSummaryFields = (ids) => ({
     // for belongs on run.get alone.
     runId: ids.run,
     status: z
-        .enum(publicRunStatusValues)
-        .describe("Whole-run status, and the value to gate a pipeline on. Terminal statuses are passed, failed, and canceled; poll until one is reached. `failed` means the run found a bug that is still open and serious enough to block — a lower-priority bug, or one since resolved, reads `passed`, and the per-flow diagnoses are still in `flows`. The run stays `running` while any investigation is unresolved, including one that carried over to a later run, so a terminal status always means a settled answer. `needsReview` tells such a run apart from one that is still executing."),
+        .enum(publicRunSummaryStatusValues)
+        .describe("Whole-run status, and the value to gate a pipeline on. Terminal statuses are passed, failed, canceled, and superseded; poll until one is reached. `failed` means the run found a bug that is still open and serious enough to block — a lower-priority bug, or one since resolved, reads `passed`, and the per-flow diagnoses are still in `flows`. The run stays `running` while any investigation is unresolved, including one that carried over to a later run, so a terminal status always means a settled answer, and `needsReview` tells such a run apart from one that is still executing. `superseded` means a newer run replaced this one before it finished: it is not a pass, this run will never change again, and the verdict belongs to the run in `supersededBy`."),
+    supersededBy: z
+        .object({
+        runId: ids.run,
+        url: z.url().describe("Absolute URL of the replacement run's page."),
+    })
+        .optional()
+        .describe("The run that replaced this one, present only when `status` is `superseded`. A newer deployment to the same branch and environment (and service, when the deployment named one) cancels the older run's unfinished flows and takes over. Deduplication ignores the commit, so the replacement may be testing a later commit than this run did. Only the direct replacement is named; that run can itself be superseded."),
 });
 //# sourceMappingURL=summary.js.map

package/dist/v1/run/summary.js.map

@@ -1 +1 @@
-{"version":3,"file":"summary.js","sourceRoot":"","sources":["../../../src/v1/run/summary.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAIxB,8EAA8E;AAC9E,MAAM,CAAC,MAAM,qBAAqB,GAAG;IACnC,QAAQ;IACR,SAAS;IACT,QAAQ;IACR,QAAQ;IACR,UAAU;CACF,CAAC;AAEX,6EAA6E;AAC7E,2EAA2E;AAC3E,sCAAsC;AACtC,MAAM,CAAC,MAAM,oBAAoB,GAAG,CAA+B,GAElE,EAAE,EAAE,CAAC,CAAC;IACL,WAAW,EAAE,CAAC,CAAC,GAAG;SACf,QAAQ,EAAE;SACV,QAAQ,EAAE;SACV,QAAQ,CACP,+KAA+K,CAChL;IACH,SAAS,EAAE,CAAC,CAAC,GAAG,CAAC,QAAQ,EAAE;IAC3B,GAAG,EAAE,CAAC;SACH,MAAM,CAAC;QACN,MAAM,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;QAC7B,aAAa,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;QACpC,SAAS,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;QAChC,wEAAwE;QACxE,uEAAuE;QACvE,sEAAsE;QACtE,mDAAmD;QACnD,SAAS,EAAE,CAAC;aACT,MAAM,EAAE;aACR,QAAQ,EAAE;aACV,QAAQ,CAAC,sCAAsC,CAAC;KACpD,CAAC;SACD,QAAQ,CACP,wLAAwL,CACzL;IACH,WAAW,EAAE,CAAC;SACX,OAAO,EAAE;SACT,QAAQ,EAAE;SACV,QAAQ,CACP,qUAAqU,CACtU;IACH,8EAA8E;IAC9E,8EAA8E;IAC9E,gCAAgC;IAChC,KAAK,EAAE,GAAG,CAAC,GAAG;IACd,MAAM,EAAE,CAAC;SACN,IAAI,CAAC,qBAAqB,CAAC;SAC3B,QAAQ,CACP,mjBAAmjB,CACpjB;CACJ,CAAC,CAAC"}
+{"version":3,"file":"summary.js","sourceRoot":"","sources":["../../../src/v1/run/summary.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAIxB,8EAA8E;AAC9E,MAAM,CAAC,MAAM,qBAAqB,GAAG;IACnC,QAAQ;IACR,SAAS;IACT,QAAQ;IACR,QAAQ;IACR,UAAU;CACF,CAAC;AAEX;;;;;GAKG;AACH,MAAM,CAAC,MAAM,4BAA4B,GAAG;IAC1C,GAAG,qBAAqB;IACxB,YAAY;CACJ,CAAC;AAEX,6EAA6E;AAC7E,2EAA2E;AAC3E,sCAAsC;AACtC,MAAM,CAAC,MAAM,oBAAoB,GAAG,CAA+B,GAElE,EAAE,EAAE,CAAC,CAAC;IACL,WAAW,EAAE,CAAC,CAAC,GAAG;SACf,QAAQ,EAAE;SACV,QAAQ,EAAE;SACV,QAAQ,CACP,+KAA+K,CAChL;IACH,SAAS,EAAE,CAAC,CAAC,GAAG,CAAC,QAAQ,EAAE;IAC3B,GAAG,EAAE,CAAC;SACH,MAAM,CAAC;QACN,MAAM,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;QAC7B,aAAa,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;QACpC,SAAS,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;QAChC,wEAAwE;QACxE,uEAAuE;QACvE,sEAAsE;QACtE,mDAAmD;QACnD,SAAS,EAAE,CAAC;aACT,MAAM,EAAE;aACR,QAAQ,EAAE;aACV,QAAQ,CAAC,sCAAsC,CAAC;KACpD,CAAC;SACD,QAAQ,CACP,wLAAwL,CACzL;IACH,WAAW,EAAE,CAAC;SACX,OAAO,EAAE;SACT,QAAQ,EAAE;SACV,QAAQ,CACP,qUAAqU,CACtU;IACH,8EAA8E;IAC9E,8EAA8E;IAC9E,gCAAgC;IAChC,KAAK,EAAE,GAAG,CAAC,GAAG;IACd,MAAM,EAAE,CAAC;SACN,IAAI,CAAC,4BAA4B,CAAC;SAClC,QAAQ,CACP,kvBAAkvB,CACnvB;IACH,YAAY,EAAE,CAAC;SACZ,MAAM,CAAC;QACN,KAAK,EAAE,GAAG,CAAC,GAAG;QACd,GAAG,EAAE,CAAC,CAAC,GAAG,EAAE,CAAC,QAAQ,CAAC,6CAA6C,CAAC;KACrE,CAAC;SACD,QAAQ,EAAE;SACV,QAAQ,CACP,wZAAwZ,CACzZ;CACJ,CAAC,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@qawolf/api-contracts",
-  "version": "0.73.0",
+  "version": "0.74.0",
   "private": false,
   "description": "Versioned contracts for the QA Wolf public API",
   "repository": {