@shipfox/api-workflows 11.0.0 → 12.1.0

package/test/factories/workflow-model.ts

@@ -10,11 +10,13 @@ import {
 type ModelStep = WorkflowModel['jobs'][number]['steps'][number];
 type AgentThinking = Extract<ModelStep, {kind: 'agent'}>['thinking'];
 type Harness = Extract<ModelStep, {kind: 'agent'}>['harness'];
+type Checkout = Extract<ModelStep, {kind: 'checkout'}>['checkout'];
 type WorkflowEnvTemplates = NonNullable<NonNullable<WorkflowModel['templates']>['env']>;
 
 interface TestWorkflowStepBase {
   readonly key?: string | undefined;
   readonly name?: string | undefined;
+  readonly workingDirectory?: string | undefined;
   readonly sourceLocation?: WorkflowModel['jobs'][number]['steps'][number]['sourceLocation'];
   readonly if?: ModelStep['if'] | undefined;
   readonly gate?: WorkflowModel['jobs'][number]['steps'][number]['gate'] | undefined;
@@ -35,13 +37,18 @@ interface TestAgentStep extends TestWorkflowStepBase {
   readonly integrations?: Extract<ModelStep, {kind: 'agent'}>['integrations'] | undefined;
 }
 
-type TestWorkflowStep = TestRunStep | TestAgentStep;
+interface TestCheckoutStep extends TestWorkflowStepBase {
+  readonly checkout: Checkout;
+}
+
+type TestWorkflowStep = TestRunStep | TestAgentStep | TestCheckoutStep;
 
 const DEFAULT_RUNNER_LABELS = ['ubuntu-latest'] as const;
 
 interface TestWorkflowJob {
   readonly needs?: string | readonly string[] | undefined;
   readonly name?: string | undefined;
+  readonly executionName?: string | undefined;
   readonly runner?: string | readonly string[] | undefined;
   readonly runnerTemplates?: readonly string[] | undefined;
   readonly checkout?: WorkflowModel['jobs'][number]['checkout'] | undefined;
@@ -55,6 +62,7 @@ interface TestWorkflowJob {
 
 interface TestWorkflowModelInput {
   readonly name?: string | undefined;
+  readonly runName?: string | undefined;
   readonly runner?: string | readonly string[] | undefined;
   readonly env?: WorkflowModel['env'] | undefined;
   readonly jobs?: Readonly<Record<string, TestWorkflowJob>> | undefined;
@@ -84,11 +92,12 @@ export function workflowModel(input: TestWorkflowModelInput = {}): WorkflowModel
       ...(job.if === undefined ? {} : {if: workflowExpression(job.if)}),
       ...(job.success === undefined ? {} : {success: job.success}),
       ...(job.outputs === undefined ? {} : {outputs: outputTemplates(job.outputs)}),
-      ...(job.name === undefined
+      ...(job.name === undefined ? {} : {name: job.name}),
+      ...(job.executionName === undefined
         ? {}
         : {
-            name: fieldTemplate('job.name', job.name) ?? [
-              {kind: 'literal' as const, value: job.name},
+            executionName: fieldTemplate('job.execution_name', job.executionName) ?? [
+              {kind: 'literal' as const, value: job.executionName},
             ],
           }),
       ...(job.listening === undefined ? {} : {listening: job.listening}),
@@ -101,6 +110,13 @@ export function workflowModel(input: TestWorkflowModelInput = {}): WorkflowModel
   return {
     kind: 'workflow',
     name: input.name ?? 'Test Workflow',
+    ...(input.runName === undefined
+      ? {}
+      : {
+          runName: fieldTemplate('workflow.run_name', input.runName) ?? [
+            {kind: 'literal' as const, value: input.runName},
+          ],
+        }),
     ...optionalScopedEnv(input.env),
     triggers: [],
     jobs: modelJobs,
@@ -128,26 +144,36 @@ function outputTemplates(outputs: Readonly<Record<string, string>>) {
 
 function normalizeStep(step: TestWorkflowStep, jobId: string, stepIndex: number): ModelStep {
   const base = stepBase(step, jobId, stepIndex);
-  return 'run' in step
-    ? {
-        ...base,
-        kind: 'run',
-        command: {kind: 'shell', value: step.run},
-        ...optionalRunTemplates(step),
-        ...optionalStepEnv(step.env),
-      }
-    : {
-        ...base,
-        kind: 'agent',
-        ...(step.harness === undefined ? {} : {harness: step.harness}),
-        ...(step.model === undefined ? {} : {model: step.model}),
-        ...(step.provider === undefined ? {} : {provider: step.provider}),
-        ...(step.thinking === undefined ? {} : {thinking: step.thinking}),
-        ...(step.tools === undefined ? {} : {tools: step.tools}),
-        ...(step.integrations === undefined ? {} : {integrations: step.integrations}),
-        prompt: step.prompt,
-        ...optionalAgentTemplates(step),
-      };
+  if ('run' in step) {
+    return {
+      ...base,
+      kind: 'run',
+      command: {kind: 'shell', value: step.run},
+      ...optionalRunTemplates(step),
+      ...optionalStepEnv(step.env),
+    };
+  }
+
+  if ('prompt' in step) {
+    return {
+      ...base,
+      kind: 'agent',
+      ...(step.harness === undefined ? {} : {harness: step.harness}),
+      ...(step.model === undefined ? {} : {model: step.model}),
+      ...(step.provider === undefined ? {} : {provider: step.provider}),
+      ...(step.thinking === undefined ? {} : {thinking: step.thinking}),
+      ...(step.tools === undefined ? {} : {tools: step.tools}),
+      ...(step.integrations === undefined ? {} : {integrations: step.integrations}),
+      prompt: step.prompt,
+      ...optionalAgentTemplates(step),
+    };
+  }
+
+  return {
+    ...base,
+    kind: 'checkout',
+    checkout: step.checkout,
+  };
 }
 
 function stepBase(step: TestWorkflowStep, jobId: string, stepIndex: number) {
@@ -156,6 +182,7 @@ function stepBase(step: TestWorkflowStep, jobId: string, stepIndex: number) {
       step.key === undefined ? `${jobId}-step-${stepIndex + 1}` : `${jobId}-${stableId(step.key)}`,
     ...(step.key === undefined ? {} : {key: step.key}),
     ...(step.name === undefined ? {} : {name: step.name}),
+    ...(step.workingDirectory === undefined ? {} : {workingDirectory: step.workingDirectory}),
     ...(step.sourceLocation === undefined ? {} : {sourceLocation: step.sourceLocation}),
     ...(step.if === undefined ? {} : {if: step.if}),
     ...(step.gate === undefined ? {} : {gate: step.gate}),
@@ -188,12 +215,24 @@ function optionalStepEnv(
 function optionalRunTemplates(step: TestRunStep) {
   const command = fieldTemplate('run', step.run);
   const name = step.name === undefined ? undefined : fieldTemplate('step.name', step.name);
+  const workingDirectory =
+    step.workingDirectory === undefined
+      ? undefined
+      : fieldTemplate('step.working_directory', step.workingDirectory);
   const env = envTemplates(step.env);
-  if (command === undefined && name === undefined && env === undefined) return {};
+  if (
+    command === undefined &&
+    name === undefined &&
+    workingDirectory === undefined &&
+    env === undefined
+  ) {
+    return {};
+  }
   return {
     templates: {
       ...(command === undefined ? {} : {command}),
       ...(name === undefined ? {} : {name}),
+      ...(workingDirectory === undefined ? {} : {workingDirectory}),
       ...(env === undefined ? {} : {env}),
     },
   };
@@ -204,8 +243,21 @@ function optionalAgentTemplates(step: TestAgentStep) {
   const model = step.model === undefined ? undefined : fieldTemplate('agent.model', step.model);
   const provider =
     step.provider === undefined ? undefined : fieldTemplate('agent.provider', step.provider);
+  const thinking =
+    step.thinking === undefined ? undefined : fieldTemplate('agent.thinking', step.thinking);
   const name = step.name === undefined ? undefined : fieldTemplate('step.name', step.name);
-  if (prompt === undefined && model === undefined && provider === undefined && name === undefined) {
+  const workingDirectory =
+    step.workingDirectory === undefined
+      ? undefined
+      : fieldTemplate('step.working_directory', step.workingDirectory);
+  if (
+    prompt === undefined &&
+    model === undefined &&
+    provider === undefined &&
+    thinking === undefined &&
+    name === undefined &&
+    workingDirectory === undefined
+  ) {
     return {};
   }
   return {
@@ -213,7 +265,9 @@ function optionalAgentTemplates(step: TestAgentStep) {
       ...(prompt === undefined ? {} : {prompt}),
       ...(model === undefined ? {} : {model}),
       ...(provider === undefined ? {} : {provider}),
+      ...(thinking === undefined ? {} : {thinking}),
       ...(name === undefined ? {} : {name}),
+      ...(workingDirectory === undefined ? {} : {workingDirectory}),
     },
   };
 }

package/test/factories/workflow-run.ts

@@ -19,7 +19,7 @@ export const workflowRunFactory = Factory.define<WorkflowRun, WorkflowRunTransie
         workspaceId: run.workspaceId,
         projectId: run.projectId,
         definitionId: run.definitionId,
-        name: run.name,
+        name: run.workflowName,
         model: transientParams.model ?? workflowModel({name: run.name}),
         triggerPayload: run.triggerPayload,
         inputs: run.inputs ?? undefined,
@@ -32,7 +32,10 @@ export const workflowRunFactory = Factory.define<WorkflowRun, WorkflowRunTransie
       workspaceId,
       projectId,
       definitionId,
+      number: 1,
       name: 'Test Workflow',
+      workflowName: 'Test Workflow',
+      nameOverride: null,
       status: 'pending',
       currentAttempt: 1,
       triggerProvider: null,

package/test/fixtures/agent-inter-module.ts

@@ -9,6 +9,7 @@ import type {
   AgentInterModuleClient,
   AgentValidationCatalog,
 } from '@shipfox/api-agent-dto/inter-module';
+import {agentThinkingSchema} from '@shipfox/workflow-document';
 import type {AgentDefaultsResolver} from '#core/agent-defaults.js';
 
 export const agentValidationCatalog: AgentValidationCatalog = {
@@ -53,6 +54,6 @@ export const resolveTestAgentDefaults: AgentDefaultsResolver = (config) => {
     harness: config.harness ?? 'pi',
     provider,
     model: config.model ?? (provider === 'openai' ? 'gpt-5.5-pro' : 'claude-opus-4-8'),
-    thinking: config.thinking ?? 'xhigh',
+    thinking: agentThinkingSchema.safeParse(config.thinking).data ?? 'xhigh',
   };
 };

package/test/fixtures/job-with-steps.ts

@@ -3,7 +3,7 @@ import {createWorkflowRun, getJobsByWorkflowRunId, getStepsByJobId} from '#db/wo
 import {stripSetupStep} from '#test/fixtures/strip-setup-step.js';
 import {workflowModel} from '#test/index.js';
 
-// Jobs and steps have no standalone factory — they only exist as children
+// Jobs and steps have no standalone factory: they only exist as children
 // materialized from a WorkflowModel by createWorkflowRun, which also prepends a
 // synthetic "Set up job" step to every job. This fixture exercises step-execution
 // mechanics in isolation, so it strips that step (see stripSetupStep) to keep the