@shipfox/api-workflows-dto 2.0.0 → 6.0.0

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@shipfox/api-workflows-dto",
   "license": "MIT",
-  "version": "2.0.0",
+  "version": "6.0.0",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/ShipfoxHQ/shipfox.git",
@@ -13,34 +13,30 @@
   "types": "dist/index.d.ts",
   "imports": {
     "#test/*": "./test/*",
-    "#*": {
-      "workspace-source": "./src/*",
-      "development": "./src/*",
-      "default": "./dist/*"
-    }
+    "#*": "./dist/*"
   },
   "exports": {
     ".": {
-      "development": {
-        "types": "./src/index.ts",
-        "default": "./src/index.ts"
-      },
-      "default": {
-        "types": "./dist/index.d.ts",
-        "default": "./dist/index.js"
-      }
+      "types": "./dist/index.d.ts",
+      "default": "./dist/index.js"
+    },
+    "./inter-module": {
+      "types": "./dist/inter-module.d.ts",
+      "default": "./dist/inter-module.js"
     }
   },
   "dependencies": {
-    "zod": "^4.4.3"
+    "zod": "^4.4.3",
+    "@shipfox/api-agent-dto": "6.0.0",
+    "@shipfox/inter-module": "0.2.0"
   },
   "devDependencies": {
+    "@shipfox/biome": "1.8.2",
+    "@shipfox/depcruise": "1.0.2",
+    "@shipfox/swc": "1.2.6",
     "@shipfox/ts-config": "1.3.8",
-    "@shipfox/depcruise": "1.0.1",
-    "@shipfox/swc": "1.2.5",
-    "@shipfox/biome": "1.8.1",
-    "@shipfox/typescript": "1.1.6",
-    "@shipfox/vitest": "1.2.2"
+    "@shipfox/typescript": "1.1.7",
+    "@shipfox/vitest": "1.2.3"
   },
   "scripts": {
     "build": "shipfox-swc",

package/src/inter-module.test.ts

@@ -0,0 +1,87 @@
+import {workflowsInterModuleContract} from './inter-module.js';
+
+describe('workflowsInterModuleContract', () => {
+  test('accepts trigger commands and listener deliveries', () => {
+    const start = workflowsInterModuleContract.methods.startRunFromTrigger.input.parse({
+      workspaceId: '00000000-0000-4000-8000-000000000001',
+      projectId: '00000000-0000-4000-8000-000000000002',
+      definitionId: '00000000-0000-4000-8000-000000000003',
+      triggerPayload: {
+        provider: 'github',
+        source: 'github',
+        event: 'push',
+        deliveryId: 'delivery-1',
+        data: {ref: 'refs/heads/main'},
+      },
+      idempotencyKey: 'subscription-1:event-1',
+    });
+    const delivery = workflowsInterModuleContract.methods.deliverEventToJobListener.input.parse({
+      jobId: '00000000-0000-4000-8000-000000000004',
+      disposition: 'fire',
+      eventRef: 'event-1',
+      deliveryId: 'delivery-1',
+      source: 'github',
+      event: 'push',
+      provider: 'github',
+      payload: {ref: 'refs/heads/main'},
+      receivedAt: '2026-07-20T12:00:00.000Z',
+    });
+
+    expect(start.idempotencyKey).toBe('subscription-1:event-1');
+    expect(delivery.disposition).toBe('fire');
+  });
+
+  test('accepts the minimal Logs and agent-tools query payloads', () => {
+    const stepId = '00000000-0000-4000-8000-000000000006';
+    const logContext = workflowsInterModuleContract.methods.getStepLogContext.input.parse({stepId});
+    const agentTools = workflowsInterModuleContract.methods.getLeasedAgentToolContext.input.parse({
+      jobId: '00000000-0000-4000-8000-000000000007',
+      jobExecutionId: '00000000-0000-4000-8000-000000000008',
+      runnerSessionId: '00000000-0000-4000-8000-000000000009',
+      stepId,
+      attempt: 1,
+    });
+
+    expect(logContext).toEqual({stepId});
+    expect(agentTools.attempt).toBe(1);
+  });
+
+  test.each([
+    ['definition-not-found', {definitionId: '00000000-0000-4000-8000-000000000001'}],
+    ['project-mismatch', {}],
+    ['agent-config-unresolvable', {definitionId: '00000000-0000-4000-8000-000000000001'}],
+    ['agent-integration-materialization-failed', {}],
+    [
+      'interpolation-unresolvable',
+      {
+        definitionId: '00000000-0000-4000-8000-000000000001',
+        field: 'env',
+        source: 'event.ref',
+        envKey: 'REF',
+      },
+    ],
+    ['invalid-job-runner-labels', {labels: ['linux', 'gpu']}],
+  ] as const)('defines the %s start-run failure', (code, details) => {
+    const schema = workflowsInterModuleContract.methods.startRunFromTrigger.errors[code];
+    const parsed = schema.parse(details);
+
+    expect(parsed).toEqual(details);
+  });
+
+  test.each([
+    'lease-not-active',
+    'step-not-found',
+    'job-not-found',
+    'step-attempt-mismatch',
+    'step-not-running',
+    'leased-step-not-agent',
+    'agent-step-config-invalid',
+  ])('defines the %s agent-tools failure', (code) => {
+    const schema =
+      workflowsInterModuleContract.methods.getLeasedAgentToolContext.errors[
+        code as keyof typeof workflowsInterModuleContract.methods.getLeasedAgentToolContext.errors
+      ];
+
+    expect(schema.parse({})).toEqual({});
+  });
+});

package/src/inter-module.ts

@@ -0,0 +1,116 @@
+import {harnessSchema, materializedAgentIntegrationSchema} from '@shipfox/api-agent-dto';
+import {defineInterModuleContract, type InterModuleClient} from '@shipfox/inter-module';
+import {z} from 'zod';
+
+const idSchema = z.string().uuid();
+const triggerPayloadSchema = z.union([
+  z.object({
+    provider: z.literal('manual').optional(),
+    source: z.literal('manual'),
+    event: z.literal('fire'),
+    subscriptionId: idSchema,
+    userId: idSchema,
+  }),
+  z.object({
+    provider: z.literal('cron').optional(),
+    source: z.literal('cron'),
+    event: z.literal('tick'),
+    scheduleId: idSchema,
+  }),
+  z.object({
+    provider: z.string(),
+    source: z.string(),
+    event: z.string(),
+    deliveryId: z.string(),
+    data: z.unknown(),
+  }),
+]);
+
+const interpolationFieldSchema = z.enum([
+  'run',
+  'env',
+  'agent.prompt',
+  'agent.model',
+  'agent.provider',
+  'job.runner',
+  'job.outputs',
+  'job.name',
+  'step.name',
+  'step.feedback',
+]);
+
+/**
+ * Producer-owned Workflows commands used by synchronous callers. Commands carry
+ * stable identities whenever a retry could create a duplicate run.
+ */
+export const workflowsInterModuleContract = defineInterModuleContract({
+  module: 'workflows',
+  methods: {
+    startRunFromTrigger: {
+      input: z.object({
+        workspaceId: idSchema,
+        projectId: idSchema,
+        definitionId: idSchema,
+        triggerPayload: triggerPayloadSchema,
+        inputs: z.record(z.string(), z.unknown()).optional(),
+        idempotencyKey: z.string().min(1),
+      }),
+      output: z.object({id: idSchema, name: z.string()}),
+      errors: {
+        'definition-not-found': z.object({definitionId: idSchema}),
+        'project-mismatch': z.object({}),
+        'agent-config-unresolvable': z.object({definitionId: idSchema}),
+        'agent-integration-materialization-failed': z.object({}),
+        'interpolation-unresolvable': z.object({
+          definitionId: idSchema,
+          field: interpolationFieldSchema,
+          source: z.string(),
+          envKey: z.string().optional(),
+        }),
+        'invalid-job-runner-labels': z.object({labels: z.array(z.string())}),
+      },
+    },
+    deliverEventToJobListener: {
+      input: z.object({
+        jobId: idSchema,
+        disposition: z.enum(['fire', 'resolve']),
+        eventRef: z.string().min(1),
+        deliveryId: z.string().min(1),
+        source: z.string().min(1),
+        event: z.string().min(1),
+        provider: z.string().min(1),
+        payload: z.unknown(),
+        receivedAt: z.string().datetime(),
+      }),
+      output: z.object({buffered: z.boolean(), skipped: z.boolean()}),
+    },
+    getStepLogContext: {
+      input: z.object({stepId: idSchema}),
+      output: z.object({harness: harnessSchema}),
+    },
+    getLeasedAgentToolContext: {
+      input: z.object({
+        jobId: idSchema,
+        jobExecutionId: idSchema,
+        runnerSessionId: idSchema,
+        stepId: idSchema,
+        attempt: z.number().int().positive(),
+      }),
+      output: z.object({
+        workspaceId: idSchema,
+        integrations: z.array(materializedAgentIntegrationSchema),
+      }),
+      errors: {
+        'lease-not-active': z.object({}),
+        'step-not-found': z.object({}),
+        'job-not-found': z.object({}),
+        'step-attempt-mismatch': z.object({}),
+        'step-not-running': z.object({}),
+        'leased-step-not-agent': z.object({}),
+        'agent-step-config-invalid': z.object({}),
+      },
+    },
+  },
+});
+
+export type WorkflowsModuleClient = InterModuleClient<typeof workflowsInterModuleContract>;