@shipfox/api-workflows-dto 12.6.0 → 12.7.0

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@shipfox/api-workflows-dto",
   "license": "MIT",
-  "version": "12.6.0",
+  "version": "12.7.0",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/ShipfoxHQ/shipfox.git",

package/src/schemas/workflow-run-detail.ts

@@ -72,6 +72,14 @@ export type WorkflowRunJobDetailDto = z.infer<typeof workflowRunJobDetailDtoSche
 export const workflowRunDetailResponseSchema = workflowRunResponseSchema.extend({
   run_attempt: workflowRunAttemptDtoSchema,
   jobs: z.array(workflowRunJobDetailDtoSchema),
+  /**
+   * Whether any job execution of this attempt reached its runner. Redundant with the executions
+   * below, and deliberately so: the server decides it once for both this response and the run
+   * list, which is what keeps the two surfaces from reaching different answers.
+   *
+   * Defaults to started for the same rollout reason as the list item's copy.
+   */
+  has_started_job_execution: z.boolean().optional().default(true),
 });
 
 export type WorkflowRunDetailResponseDto = z.infer<typeof workflowRunDetailResponseSchema>;

package/src/schemas/workflow-run.test.ts

@@ -120,6 +120,7 @@ describe('workflow run list item schema', () => {
       source_snapshot: null,
       jobs: [jobDto(0)],
       job_status_counts: [{status: 'succeeded', count: 1}],
+      has_started_job_execution: true,
     });
 
     expect(result.jobs).toHaveLength(1);
@@ -185,6 +186,7 @@ describe('workflow run list item schema', () => {
         {status: 'succeeded', count: 40},
         {status: 'failed', count: 2},
       ],
+      has_started_job_execution: true,
     });
 
     expect(result.job_status_counts).toHaveLength(2);
@@ -196,6 +198,7 @@ describe('workflow run list item schema', () => {
       source_snapshot: null,
       jobs: Array.from({length: WORKFLOW_RUN_JOB_PREVIEW_LIMIT + 1}, (_, index) => jobDto(index)),
       job_status_counts: [],
+      has_started_job_execution: false,
     });
 
     expect(result.success).toBe(false);

package/src/schemas/workflow-run.ts

@@ -201,6 +201,14 @@ export const workflowRunListItemSchema = workflowRunResponseSchema.extend({
    * Optional so a new web client can consume an older API response during rollout.
    */
   job_display_status_counts: z.array(workflowRunJobDisplayStatusCountDtoSchema).optional(),
+  /**
+   * Whether any job execution in the attempt reached its runner. A `cancelled` job does not say
+   * this on its own, so the counts above cannot answer it.
+   *
+   * Defaults to started, so an older API response during a rollout keeps the reading a run had
+   * before this field existed rather than claiming work that ran never began.
+   */
+  has_started_job_execution: z.boolean().optional().default(true),
 });
 
 export type WorkflowRunListItemDto = z.input<typeof workflowRunListItemSchema>;