@shipfox/client-workflows 5.0.0 → 6.0.2

package/src/core/entities/workflow-run-attempt.ts

@@ -1,4 +1,3 @@
-import type {WorkflowRunAttemptDto} from '@shipfox/api-workflows-dto';
 import {type Duration, intervalToDuration} from 'date-fns';
 import type {WorkflowRunStatus} from './workflow-run.js';
 
@@ -48,19 +47,6 @@ export class WorkflowRunAttempt extends WorkflowRunAttemptSummary {
   }
 }
 
-export function toWorkflowRunAttempt(dto: WorkflowRunAttemptDto): WorkflowRunAttempt {
-  return new WorkflowRunAttempt({
-    id: dto.id,
-    workflowRunId: dto.workflow_run_id,
-    attempt: dto.attempt,
-    status: dto.status,
-    createdAt: dto.created_at,
-    startedAt: dto.started_at ?? null,
-    finishedAt: dto.finished_at ?? null,
-    rerunMode: dto.rerun_mode,
-  });
-}
-
 export function workflowRunAttemptDisplayDurationFromTimestamps({
   startedAt,
   finishedAt,

package/src/core/entities/workflow-run.ts

@@ -1,17 +1,8 @@
-import type {
-  WorkflowRunDetailResponseDto,
-  WorkflowRunListResponseDto,
-  WorkflowRunResponseDto,
-  WorkflowRunStatusDto,
-} from '@shipfox/api-workflows-dto';
-import {type Job, toJob, WORKFLOW_JOB_STATUSES} from './job.js';
-import {
-  toWorkflowRunAttempt,
-  type WorkflowRunAttempt,
-  WorkflowRunAttemptSummary,
-} from './workflow-run-attempt.js';
+import {type Job, WORKFLOW_JOB_STATUSES} from './job.js';
+import type {WorkflowRunAttempt, WorkflowRunAttemptSummary} from './workflow-run-attempt.js';
 
-export type WorkflowRunStatus = WorkflowRunStatusDto;
+export type WorkflowRunStatus = 'pending' | 'running' | 'succeeded' | 'failed' | 'cancelled';
+export type WorkflowRunRerunMode = 'all' | 'failed';
 export type WorkflowStatus = WorkflowRunStatus | (typeof WORKFLOW_JOB_STATUSES)[number];
 
 export const WORKFLOW_RUN_STATUSES = [
@@ -77,6 +68,10 @@ export interface WorkflowRunListPage {
   filteredTotalCount: number | null;
 }
 
+export interface ManualWorkflowLaunch {
+  workflowRunId: string;
+}
+
 export function workflowRunShortId(id: string): string {
   return id.length <= 8 ? id : id.slice(0, 8);
 }
@@ -108,76 +103,3 @@ export function isWorkflowRunTerminal(status: WorkflowRunStatus): boolean {
 export function isWorkflowStatus(status: string): status is WorkflowStatus {
   return WORKFLOW_STATUSES.has(status as WorkflowStatus);
 }
-
-export function toWorkflowRun(dto: WorkflowRunResponseDto): WorkflowRun {
-  const triggerLabel = workflowRunTriggerLabel({
-    triggerSource: dto.trigger_source,
-    triggerEvent: dto.trigger_event,
-  });
-  const triggerDisplayLabel = workflowRunTriggerDisplayLabel({
-    triggerSource: dto.trigger_source,
-    triggerEvent: dto.trigger_event,
-  });
-
-  return {
-    id: dto.id,
-    projectId: dto.project_id,
-    definitionId: dto.definition_id,
-    name: dto.name,
-    currentAttempt: dto.current_attempt,
-    triggerProvider: dto.trigger_provider,
-    triggerSource: dto.trigger_source,
-    triggerEvent: dto.trigger_event,
-    triggerDisplayLabel,
-    triggerLabel,
-    triggerPayload: dto.trigger_payload,
-    inputs: dto.inputs ?? null,
-    sourceSnapshot: dto.source_snapshot ? toWorkflowSourceSnapshot(dto.source_snapshot) : null,
-    createdAt: dto.created_at,
-    updatedAt: dto.updated_at,
-    shortId: workflowRunShortId(dto.id),
-    isTemporary: dto.id.startsWith('temp-'),
-  };
-}
-
-export function toWorkflowRunListItem(dto: WorkflowRunResponseDto): WorkflowRunListItem {
-  return {
-    ...toWorkflowRun(dto),
-    status: dto.status,
-    latestAttempt: dto.latest_attempt,
-    runAttempt: new WorkflowRunAttemptSummary({
-      workflowRunId: dto.id,
-      attempt: dto.current_attempt,
-      status: dto.status,
-      createdAt: dto.created_at,
-      startedAt: dto.started_at ?? null,
-      finishedAt: dto.finished_at ?? null,
-    }),
-  };
-}
-
-export function toWorkflowRunDetail(dto: WorkflowRunDetailResponseDto): WorkflowRunDetail {
-  return {
-    ...toWorkflowRun(dto),
-    latestAttempt: dto.latest_attempt,
-    runAttempt: toWorkflowRunAttempt(dto.run_attempt),
-    jobs: dto.jobs.map(toJob),
-  };
-}
-
-export function toWorkflowRunListPage(dto: WorkflowRunListResponseDto): WorkflowRunListPage {
-  return {
-    runs: dto.runs.map(toWorkflowRunListItem),
-    nextCursor: dto.next_cursor,
-    filteredTotalCount: dto.filtered_total_count,
-  };
-}
-
-function toWorkflowSourceSnapshot(
-  dto: NonNullable<WorkflowRunResponseDto['source_snapshot']>,
-): WorkflowSourceSnapshot {
-  return {
-    content: dto.content,
-    format: dto.format,
-  };
-}

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

@@ -1,3 +1,10 @@
+import {
+  toWorkflowRun,
+  toWorkflowRunAttempt,
+  toWorkflowRunDetail,
+  toWorkflowRunListItem,
+  toWorkflowRunListPage,
+} from '#hooks/api/workflow-run-mapper.js';
 import {
   workflowJobDto,
   workflowJobExecutionDto,
@@ -11,11 +18,6 @@ import {
 import {
   isWorkflowRunTerminal,
   isWorkflowStatus,
-  toWorkflowRun,
-  toWorkflowRunAttempt,
-  toWorkflowRunDetail,
-  toWorkflowRunListItem,
-  toWorkflowRunListPage,
   workflowRunShortId,
   workflowRunTriggerDisplayLabel,
   workflowRunTriggerLabel,
@@ -313,11 +315,11 @@ describe('workflow run model mapping', () => {
       listening: {
         on: [{source: 'github', event: 'deployment_status'}],
         until: [{source: 'slack', event: 'approval'}],
-        timeout_ms: 1_800_000,
-        max_executions: 10,
+        timeoutMs: 1_800_000,
+        maxExecutions: 10,
         batch: null,
-        on_resolve: 'finish',
-        execution_timeout_ms: null,
+        onResolve: 'finish',
+        executionTimeoutMs: null,
         name: null,
       },
       listenerStatus: 'listening',
@@ -328,8 +330,8 @@ describe('workflow run model mapping', () => {
         {
           source: 'github',
           event: 'deployment_status',
-          delivery_id: 'delivery-1',
-          received_at: '2026-05-07T01:00:00.000Z',
+          deliveryId: 'delivery-1',
+          receivedAt: '2026-05-07T01:00:00.000Z',
           data: {state: 'success'},
         },
       ],

package/src/core/workflow-run.ts

@@ -1,5 +1,6 @@
 export type {
   JobDisplayDuration,
+  JobListening,
   JobMode,
   JobStatus,
   JobStatusReason,
@@ -12,15 +13,15 @@ export {
   Job,
   resolveJobExecution,
   TERMINAL_WORKFLOW_JOB_STATUSES,
-  toJob,
   WORKFLOW_JOB_STATUSES,
 } from './entities/job.js';
 export type {
   JobExecutionDisplayDuration,
   JobExecutionStatus,
   JobExecutionTime,
+  WorkflowExecutionEvent,
 } from './entities/job-execution.js';
-export {JobExecution, toJobExecution} from './entities/job-execution.js';
+export {JobExecution} from './entities/job-execution.js';
 export type {
   AgentConfigIssue,
   AgentStepConfig,
@@ -30,17 +31,19 @@ export type {
   StepErrorReason,
   StepSourceLocation,
 } from './entities/step.js';
-export {toStep} from './entities/step.js';
+export {AGENT_CONFIG_ISSUES, STEP_ERROR_REASONS} from './entities/step.js';
 export type {
   StepAttemptDisplayDuration,
   StepGateResult,
 } from './entities/step-attempt.js';
-export {StepAttempt, toStepAttempt} from './entities/step-attempt.js';
+export {StepAttempt} from './entities/step-attempt.js';
 export type {
+  ManualWorkflowLaunch,
   WorkflowRun,
   WorkflowRunDetail,
   WorkflowRunListItem,
   WorkflowRunListPage,
+  WorkflowRunRerunMode,
   WorkflowRunStatus,
   WorkflowSourceSnapshot,
   WorkflowStatus,
@@ -49,18 +52,10 @@ export {
   isWorkflowRunTerminal,
   isWorkflowStatus,
   TERMINAL_WORKFLOW_RUN_STATUSES,
-  toWorkflowRun,
-  toWorkflowRunDetail,
-  toWorkflowRunListItem,
-  toWorkflowRunListPage,
   WORKFLOW_RUN_STATUSES,
   workflowRunShortId,
   workflowRunTriggerDisplayLabel,
   workflowRunTriggerLabel,
 } from './entities/workflow-run.js';
 export type {WorkflowRunAttemptDisplayDuration} from './entities/workflow-run-attempt.js';
-export {
-  toWorkflowRunAttempt,
-  WorkflowRunAttempt,
-  WorkflowRunAttemptSummary,
-} from './entities/workflow-run-attempt.js';
+export {WorkflowRunAttempt, WorkflowRunAttemptSummary} from './entities/workflow-run-attempt.js';

package/src/feature.ts

@@ -1,4 +1,21 @@
-import {defineClientFeature} from '@shipfox/client-shell';
+import {defineClientFeature, type NavTabEntry} from '@shipfox/client-shell';
+
+export const workflowsNavigation = [
+  {
+    id: 'nav.runs',
+    scope: 'project',
+    label: 'Runs',
+    to: '/workspaces/$wid/projects/$pid/runs',
+    order: 100,
+  },
+  {
+    id: 'nav.workflows',
+    scope: 'project',
+    label: 'Workflows',
+    to: '/workspaces/$wid/projects/$pid/workflows',
+    order: 200,
+  },
+] as const satisfies readonly NavTabEntry[];
 
 export const workflowsFeature = defineClientFeature({
   id: 'shipfox.workflows',
@@ -19,20 +36,5 @@ export const workflowsFeature = defineClientFeature({
       impl: '@shipfox/client-workflows/routes/run-detail',
     },
   ],
-  navigation: [
-    {
-      id: 'nav.runs',
-      scope: 'project',
-      label: 'Runs',
-      to: '/workspaces/$wid/projects/$pid/runs',
-      order: 100,
-    },
-    {
-      id: 'nav.workflows',
-      scope: 'project',
-      label: 'Workflows',
-      to: '/workspaces/$wid/projects/$pid/workflows',
-      order: 200,
-    },
-  ],
+  navigation: workflowsNavigation,
 });

package/src/hooks/api/workflow-run-mapper.ts

@@ -0,0 +1,246 @@
+import type {
+  JobListeningDto,
+  StepAttemptDto,
+  StepGateResultDto,
+  WorkflowExecutionEventDto,
+  WorkflowRunAttemptDto,
+  WorkflowRunDetailResponseDto,
+  WorkflowRunJobDetailDto,
+  WorkflowRunJobExecutionDetailDto,
+  WorkflowRunListResponseDto,
+  WorkflowRunResponseDto,
+  WorkflowRunStepDetailDto,
+} from '@shipfox/api-workflows-dto';
+import {
+  Job,
+  JobExecution,
+  type JobListening,
+  type Step,
+  StepAttempt,
+  type StepGateResult,
+  type WorkflowExecutionEvent,
+  type WorkflowRun,
+  WorkflowRunAttempt,
+  WorkflowRunAttemptSummary,
+  type WorkflowRunDetail,
+  type WorkflowRunListItem,
+  type WorkflowRunListPage,
+  workflowRunShortId,
+  workflowRunTriggerDisplayLabel,
+  workflowRunTriggerLabel,
+} from '#core/workflow-run.js';
+
+export function toWorkflowRun(dto: WorkflowRunResponseDto): WorkflowRun {
+  return {
+    id: dto.id,
+    projectId: dto.project_id,
+    definitionId: dto.definition_id,
+    name: dto.name,
+    currentAttempt: dto.current_attempt,
+    triggerProvider: dto.trigger_provider,
+    triggerSource: dto.trigger_source,
+    triggerEvent: dto.trigger_event,
+    triggerDisplayLabel: workflowRunTriggerDisplayLabel({
+      triggerSource: dto.trigger_source,
+      triggerEvent: dto.trigger_event,
+    }),
+    triggerLabel: workflowRunTriggerLabel({
+      triggerSource: dto.trigger_source,
+      triggerEvent: dto.trigger_event,
+    }),
+    triggerPayload: dto.trigger_payload,
+    inputs: dto.inputs ?? null,
+    sourceSnapshot: dto.source_snapshot
+      ? {content: dto.source_snapshot.content, format: dto.source_snapshot.format}
+      : null,
+    createdAt: dto.created_at,
+    updatedAt: dto.updated_at,
+    shortId: workflowRunShortId(dto.id),
+    isTemporary: dto.id.startsWith('temp-'),
+  };
+}
+
+export function toWorkflowRunAttempt(dto: WorkflowRunAttemptDto): WorkflowRunAttempt {
+  return new WorkflowRunAttempt({
+    id: dto.id,
+    workflowRunId: dto.workflow_run_id,
+    attempt: dto.attempt,
+    status: dto.status,
+    createdAt: dto.created_at,
+    startedAt: dto.started_at ?? null,
+    finishedAt: dto.finished_at ?? null,
+    rerunMode: dto.rerun_mode,
+  });
+}
+
+export function toWorkflowRunListItem(dto: WorkflowRunResponseDto): WorkflowRunListItem {
+  return {
+    ...toWorkflowRun(dto),
+    status: dto.status,
+    latestAttempt: dto.latest_attempt,
+    runAttempt: new WorkflowRunAttemptSummary({
+      workflowRunId: dto.id,
+      attempt: dto.current_attempt,
+      status: dto.status,
+      createdAt: dto.created_at,
+      startedAt: dto.started_at ?? null,
+      finishedAt: dto.finished_at ?? null,
+    }),
+  };
+}
+
+export function toWorkflowRunListPage(dto: WorkflowRunListResponseDto): WorkflowRunListPage {
+  return {
+    runs: dto.runs.map(toWorkflowRunListItem),
+    nextCursor: dto.next_cursor,
+    filteredTotalCount: dto.filtered_total_count,
+  };
+}
+
+export function toWorkflowRunDetail(dto: WorkflowRunDetailResponseDto): WorkflowRunDetail {
+  return {
+    ...toWorkflowRun(dto),
+    latestAttempt: dto.latest_attempt,
+    runAttempt: toWorkflowRunAttempt(dto.run_attempt),
+    jobs: dto.jobs.map(toJob),
+  };
+}
+
+export function toJob(dto: WorkflowRunJobDetailDto): Job {
+  return new Job({
+    id: dto.id,
+    runAttemptId: dto.run_attempt_id,
+    key: dto.key,
+    name: dto.name,
+    mode: dto.mode,
+    status: dto.status,
+    statusReason: dto.status_reason,
+    carriedOver: dto.carried_over,
+    listening: dto.listening ? toJobListening(dto.listening) : null,
+    listenerStatus: dto.listener_status,
+    resolutionReason: dto.resolution_reason,
+    dependencies: dto.dependencies,
+    position: dto.position,
+    createdAt: dto.created_at,
+    updatedAt: dto.updated_at,
+    jobExecutions: dto.job_executions.map(toJobExecution),
+  });
+}
+
+export function toJobExecution(dto: WorkflowRunJobExecutionDetailDto): JobExecution {
+  return new JobExecution({
+    id: dto.id,
+    jobId: dto.job_id,
+    sequence: dto.sequence,
+    name: dto.name,
+    status: dto.status,
+    statusReason: dto.status_reason,
+    triggerEvents: (dto.trigger_events ?? []).map(toWorkflowExecutionEvent),
+    queuedAt: dto.queued_at ?? null,
+    startedAt: dto.started_at ?? null,
+    finishedAt: dto.finished_at ?? null,
+    timedOutAt: dto.timed_out_at ?? null,
+    createdAt: dto.created_at,
+    updatedAt: dto.updated_at,
+    steps: dto.steps.map(toStep),
+  });
+}
+
+export function toStep(dto: WorkflowRunStepDetailDto): Step {
+  return {
+    id: dto.id,
+    jobExecutionId: dto.job_execution_id,
+    key: dto.key,
+    name: dto.name,
+    sourceLocation: dto.source_location
+      ? {startLine: dto.source_location.start_line, endLine: dto.source_location.end_line}
+      : null,
+    status: dto.status,
+    type: dto.type,
+    config: dto.config,
+    agentConfig: toAgentStepConfig(dto),
+    error: dto.error
+      ? {
+          message: dto.error.message,
+          exitCode: dto.error.exit_code ?? null,
+          signal: dto.error.signal,
+          reason: dto.error.reason,
+          agentConfigIssue: dto.error.agent_config_issue,
+          category: dto.error.category,
+        }
+      : null,
+    position: dto.position,
+    currentAttempt: dto.current_attempt,
+    createdAt: dto.created_at,
+    updatedAt: dto.updated_at,
+    attempts: dto.attempts.map((attempt) => toStepAttempt(attempt, dto.job_execution_id)),
+  };
+}
+
+export function toStepAttempt(dto: StepAttemptDto, jobExecutionId: string): StepAttempt {
+  return new StepAttempt({
+    id: dto.id,
+    stepId: dto.step_id,
+    jobExecutionId,
+    attempt: dto.attempt,
+    executionOrder: dto.execution_order,
+    status: dto.status,
+    exitCode: dto.exit_code ?? null,
+    output: dto.output ?? null,
+    error: dto.error ?? null,
+    gateResult: toStepGateResult(dto.gate_result),
+    restartFeedback: dto.restart_feedback ?? null,
+    startedAt: dto.started_at,
+    finishedAt: dto.finished_at ?? null,
+  });
+}
+
+function toJobListening(dto: JobListeningDto): JobListening {
+  return {
+    on: dto.on,
+    until: dto.until,
+    timeoutMs: dto.timeout_ms,
+    maxExecutions: dto.max_executions,
+    batch: dto.batch
+      ? {
+          debounceMs: dto.batch.debounce_ms,
+          maxSize: dto.batch.max_size,
+          maxWaitMs: dto.batch.max_wait_ms,
+        }
+      : null,
+    onResolve: dto.on_resolve,
+    executionTimeoutMs: dto.execution_timeout_ms,
+    name: dto.name,
+  };
+}
+
+function toWorkflowExecutionEvent(dto: WorkflowExecutionEventDto): WorkflowExecutionEvent {
+  return {
+    source: dto.source,
+    event: dto.event,
+    deliveryId: dto.delivery_id,
+    receivedAt: dto.received_at,
+    data: dto.data,
+  };
+}
+
+function toStepGateResult(dto: StepGateResultDto): StepGateResult {
+  if (dto === null || dto.kind === 'none' || dto.kind === 'not_evaluated') return dto;
+  if (dto.kind === 'passed' || dto.kind === 'failed') return {...dto, exitCode: dto.exit_code};
+  if (dto.kind === 'uncheckable' || dto.kind === 'evaluation_error')
+    return {...dto, exitCode: dto.exit_code};
+  return dto;
+}
+
+function toAgentStepConfig(dto: WorkflowRunStepDetailDto): Step['agentConfig'] {
+  if (dto.type !== 'agent') return null;
+  return {
+    provider: stringConfigValue(dto.config.provider),
+    model: stringConfigValue(dto.config.model),
+    thinking: stringConfigValue(dto.config.thinking),
+  };
+}
+
+function stringConfigValue(value: unknown): string | null {
+  return typeof value === 'string' && value.trim() ? value.trim() : null;
+}