@shipfox/api-workflows-dto 12.3.0 → 12.5.0

package/package.json

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

package/src/events.test.ts

@@ -139,6 +139,45 @@ describe('workflowsJobTerminatedSchema', () => {
     expect(result).toEqual(input);
   });
 
+  it('accepts a string status reason message', () => {
+    const input = {
+      ...validJobTerminated,
+      status: 'failed',
+      statusReason: 'output_too_large',
+      statusReasonMessage: 'Job output exceeded the configured size limit.',
+    };
+
+    const result = workflowsJobTerminatedSchema.parse(input);
+
+    expect(result).toEqual(input);
+  });
+
+  it('accepts a null status reason message', () => {
+    const input = {
+      ...validJobTerminated,
+      status: 'failed',
+      statusReason: 'unknown',
+      statusReasonMessage: null,
+    };
+
+    const result = workflowsJobTerminatedSchema.parse(input);
+
+    expect(result).toEqual(input);
+  });
+
+  it('rejects a non-string status reason message', () => {
+    const input = {
+      ...validJobTerminated,
+      status: 'failed',
+      statusReason: 'output_too_large',
+      statusReasonMessage: 413,
+    };
+
+    const parse = () => workflowsJobTerminatedSchema.parse(input);
+
+    expect(parse).toThrow();
+  });
+
   it('strips unknown keys (tolerant of forward-compatible producer additions)', () => {
     const input = {...validJobTerminated, addedLater: 'ignored'};
 

package/src/events.ts

@@ -147,6 +147,7 @@ export const workflowsJobTerminatedSchema = z.object({
   workflowRunAttemptId: nonEmptyStringSchema,
   status: jobTerminalStatusSchema,
   statusReason: jobStatusReasonSchema.nullable(),
+  statusReasonMessage: z.string().nullable().optional(),
 });
 export type WorkflowsJobTerminatedEventDto = z.infer<typeof workflowsJobTerminatedSchema>;
 

package/src/schemas/job.test.ts

@@ -42,4 +42,17 @@ describe('job DTO schema', () => {
 
     expect(result.status_reason).toBe(statusReason);
   });
+
+  it.each([
+    'output_too_large',
+    'output_invalid',
+  ] as const)('accepts job failure reason "%s"', (statusReason) => {
+    const result = jobDtoSchema.parse({
+      ...baseJob,
+      status: 'failed',
+      status_reason: statusReason,
+    });
+
+    expect(result.status_reason).toBe(statusReason);
+  });
 });

package/src/schemas/job.ts

@@ -26,8 +26,10 @@ export const jobStatusReasonSchema = z.enum([
   'run_cancelled',
   'timed_out',
   'runner_lost',
+  'output_too_large',
   'step_failed',
   'unknown',
+  'output_invalid',
 ]);
 
 export const jobDtoSchema = z.object({

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

@@ -20,6 +20,7 @@ export const jobExecutionDtoSchema = z.object({
   name: z.string(),
   status: jobExecutionStatusSchema,
   status_reason: z.string().nullable(),
+  status_reason_message: z.string().nullable().optional(),
   runner: z.array(z.string()).nullable(),
   trigger_events: z.array(workflowExecutionEventSchema).default([]),
   outputs: z.record(z.string(), z.unknown()).nullable(),