@shipfox/api-definitions 7.1.0 → 8.0.0

package/src/presentation/routes/create-definition.test.ts

@@ -1,13 +1,15 @@
 import {buildUserContext, setUserContext} from '@shipfox/api-auth-context';
-import type {IntegrationsModuleClient} from '@shipfox/api-integration-core-dto';
-import type {ProjectsModuleClient} from '@shipfox/api-projects-dto';
+import type {IntegrationsModuleClient} from '@shipfox/api-integration-core-dto/inter-module';
+import type {ProjectsModuleClient} from '@shipfox/api-projects-dto/inter-module';
 import type {FastifyInstance} from 'fastify';
 import Fastify from 'fastify';
 import {serializerCompiler, validatorCompiler} from 'fastify-type-provider-zod';
+import {agentValidationCatalog} from '#test/agent-validation-catalog.js';
 import {buildCreateDefinitionRoute} from './create-definition.js';
 
 const getProjectById = vi.fn();
 const projects = {getProjectById} as Pick<ProjectsModuleClient, 'getProjectById'>;
+const agent = {getValidationCatalog: vi.fn(() => agentValidationCatalog)};
 
 describe('POST /api/definitions', () => {
   let app: FastifyInstance;
@@ -32,7 +34,10 @@ describe('POST /api/definitions', () => {
     });
     app.post(
       '/api/definitions',
-      buildCreateDefinitionRoute({projects: projects as ProjectsModuleClient}),
+      buildCreateDefinitionRoute({
+        projects: projects as ProjectsModuleClient,
+        agent: agent as never,
+      }),
     );
     await app.ready();
   });
@@ -96,6 +101,7 @@ jobs:
       '/api/definitions',
       buildCreateDefinitionRoute({
         projects: projects as ProjectsModuleClient,
+        agent: agent as never,
         integrations: {getAgentToolsContext} as Pick<
           IntegrationsModuleClient,
           'getAgentToolsContext'
@@ -168,6 +174,7 @@ jobs:
       '/api/definitions',
       buildCreateDefinitionRoute({
         projects: projects as ProjectsModuleClient,
+        agent: agent as never,
         integrations: {getAgentToolsContext} as Pick<
           IntegrationsModuleClient,
           'getAgentToolsContext'

package/src/presentation/routes/create-definition.ts

@@ -1,10 +1,11 @@
+import type {AgentInterModuleClient} from '@shipfox/api-agent-dto/inter-module';
 import {
   createDefinitionBodySchema,
   definitionResponseSchema,
   definitionValidationErrorSchema,
 } from '@shipfox/api-definitions-dto';
-import type {IntegrationsModuleClient} from '@shipfox/api-integration-core-dto';
-import type {ProjectsModuleClient} from '@shipfox/api-projects-dto';
+import type {IntegrationsModuleClient} from '@shipfox/api-integration-core-dto/inter-module';
+import type {ProjectsModuleClient} from '@shipfox/api-projects-dto/inter-module';
 import {ClientError, defineRoute} from '@shipfox/node-fastify';
 import {z} from 'zod';
 import {DefinitionParseError} from '#core/errors.js';
@@ -17,6 +18,7 @@ import {requireProjectAccess} from './project-access.js';
 
 export interface CreateDefinitionRouteOptions {
   projects: ProjectsModuleClient;
+  agent: AgentInterModuleClient;
   integrations?: IntegrationsModuleClient;
 }
 
@@ -50,11 +52,13 @@ export function buildCreateDefinitionRoute(options: CreateDefinitionRouteOptions
       const {project_id: projectId, config_path, source, yaml: yamlString, sha, ref} = request.body;
       const project = await requireProjectAccess(request, projectId, options.projects);
 
-      const structurallyParsed = parseDefinition(yamlString);
+      const agentValidationCatalog = await options.agent.getValidationCatalog({});
+      const structurallyParsed = parseDefinition(yamlString, {agentValidationCatalog});
       const {integrations} = options;
       const parsed =
         integrations !== undefined && hasAgentStepIntegrations(structurallyParsed.document)
           ? parseDefinition(yamlString, {
+              agentValidationCatalog,
               integrationValidationContext: await loadIntegrationValidationContext(
                 integrations,
                 project.workspaceId,

package/src/presentation/routes/get-definition.test.ts

@@ -1,5 +1,5 @@
 import {buildUserContext, setUserContext} from '@shipfox/api-auth-context';
-import type {ProjectsModuleClient} from '@shipfox/api-projects-dto';
+import type {ProjectsModuleClient} from '@shipfox/api-projects-dto/inter-module';
 import type {FastifyInstance} from 'fastify';
 import Fastify from 'fastify';
 import {serializerCompiler, validatorCompiler} from 'fastify-type-provider-zod';

package/src/presentation/routes/get-definition.ts

@@ -1,5 +1,5 @@
 import {definitionResponseSchema} from '@shipfox/api-definitions-dto';
-import type {ProjectsModuleClient} from '@shipfox/api-projects-dto';
+import type {ProjectsModuleClient} from '@shipfox/api-projects-dto/inter-module';
 import {ClientError, defineRoute} from '@shipfox/node-fastify';
 import {z} from 'zod';
 import {getDefinitionById} from '#db/definitions.js';

package/src/presentation/routes/index.test.ts

@@ -1,14 +1,18 @@
 import {AUTH_USER, buildUserContext, setUserContext} from '@shipfox/api-auth-context';
-import type {ProjectsModuleClient} from '@shipfox/api-projects-dto';
+import type {ProjectsModuleClient} from '@shipfox/api-projects-dto/inter-module';
 import {type AuthMethod, ClientError, closeApp, createApp} from '@shipfox/node-fastify';
 import type {FastifyRequest} from 'fastify';
+import {agentValidationCatalog} from '#test/agent-validation-catalog.js';
 import {createDefinitionRoutes} from './index.js';
 
 const projects = {
   getProjectById: vi.fn(),
   requireProjectForWorkspace: vi.fn(),
 } as unknown as ProjectsModuleClient;
-const definitionRoutes = createDefinitionRoutes({projects});
+const definitionRoutes = createDefinitionRoutes({
+  projects,
+  agent: {getValidationCatalog: vi.fn(() => agentValidationCatalog)} as never,
+});
 
 const fakeUserAuth: AuthMethod = {
   name: AUTH_USER,

package/src/presentation/routes/index.ts

@@ -6,7 +6,7 @@ import {
 } from './create-definition.js';
 import {buildGetDefinitionRoute} from './get-definition.js';
 import {buildListDefinitionsRoute} from './list-definitions.js';
-import {validateDefinitionRoute} from './validate-definition.js';
+import {buildValidateDefinitionRoute} from './validate-definition.js';
 
 export interface DefinitionRouteOptions extends CreateDefinitionRouteOptions {}
 
@@ -19,7 +19,7 @@ export function createDefinitionRoutes(options: DefinitionRouteOptions): RouteGr
         buildCreateDefinitionRoute(options),
         buildListDefinitionsRoute(options.projects),
         buildGetDefinitionRoute(options.projects),
-        validateDefinitionRoute,
+        buildValidateDefinitionRoute(options.agent),
       ],
     },
   ];

package/src/presentation/routes/list-definitions.test.ts

@@ -1,5 +1,5 @@
 import {buildUserContext, setUserContext} from '@shipfox/api-auth-context';
-import type {ProjectsModuleClient} from '@shipfox/api-projects-dto';
+import type {ProjectsModuleClient} from '@shipfox/api-projects-dto/inter-module';
 import {encodeStringIdCursor} from '@shipfox/node-drizzle';
 import type {FastifyInstance} from 'fastify';
 import Fastify from 'fastify';

package/src/presentation/routes/list-definitions.ts

@@ -2,7 +2,7 @@ import {
   definitionListQuerySchema,
   definitionListResponseSchema,
 } from '@shipfox/api-definitions-dto';
-import type {ProjectsModuleClient} from '@shipfox/api-projects-dto';
+import type {ProjectsModuleClient} from '@shipfox/api-projects-dto/inter-module';
 import {decodeStringIdCursor, encodeStringIdCursor} from '@shipfox/node-drizzle';
 import {ClientError, defineRoute} from '@shipfox/node-fastify';
 import {listDefinitions} from '#db/definitions.js';

package/src/presentation/routes/project-access.ts

@@ -1,5 +1,5 @@
 import {requireWorkspaceAccess} from '@shipfox/api-auth-context';
-import type {ProjectsModuleClient} from '@shipfox/api-projects-dto';
+import type {ProjectsModuleClient} from '@shipfox/api-projects-dto/inter-module';
 import {ClientError} from '@shipfox/node-fastify';
 import type {FastifyRequest} from 'fastify';
 

package/src/presentation/routes/validate-definition.test.ts

@@ -1,7 +1,8 @@
 import type {FastifyInstance} from 'fastify';
 import Fastify from 'fastify';
 import {serializerCompiler, validatorCompiler} from 'fastify-type-provider-zod';
-import {validateDefinitionRoute} from './validate-definition.js';
+import {agentValidationCatalog} from '#test/agent-validation-catalog.js';
+import {buildValidateDefinitionRoute} from './validate-definition.js';
 
 describe('POST /definitions/validate', () => {
   let app: FastifyInstance;
@@ -10,7 +11,12 @@ describe('POST /definitions/validate', () => {
     app = Fastify();
     app.setValidatorCompiler(validatorCompiler);
     app.setSerializerCompiler(serializerCompiler);
-    app.post('/definitions/validate', validateDefinitionRoute);
+    app.post(
+      '/definitions/validate',
+      buildValidateDefinitionRoute({
+        getValidationCatalog: vi.fn(() => agentValidationCatalog),
+      } as never),
+    );
     await app.ready();
   });
 

package/src/presentation/routes/validate-definition.ts

@@ -1,3 +1,4 @@
+import type {AgentInterModuleClient} from '@shipfox/api-agent-dto/inter-module';
 import {definitionDtoSchema, definitionValidationErrorSchema} from '@shipfox/api-definitions-dto';
 import {defineRoute} from '@shipfox/node-fastify';
 import {z} from 'zod';
@@ -19,28 +20,32 @@ const validationResultSchema = z.union([
   }),
 ]);
 
-export const validateDefinitionRoute = defineRoute({
-  method: 'POST',
-  path: '/validate',
-  description: 'Validate a workflow definition without persisting',
-  schema: {
-    body: validateBodySchema,
-    response: {
-      200: validationResultSchema,
+export function buildValidateDefinitionRoute(agent: AgentInterModuleClient) {
+  return defineRoute({
+    method: 'POST',
+    path: '/validate',
+    description: 'Validate a workflow definition without persisting',
+    schema: {
+      body: validateBodySchema,
+      response: {
+        200: validationResultSchema,
+      },
     },
-  },
-  handler: (request) => {
-    const {yaml} = request.body;
-    const result = validateDefinition(yaml);
+    handler: async (request) => {
+      const {yaml} = request.body;
+      const result = validateDefinition(yaml, {
+        agentValidationCatalog: await agent.getValidationCatalog({}),
+      });
 
-    if (result.valid) {
-      return {
-        valid: true as const,
-        workflow_document: result.definition.document,
-        workflow_model: result.definition.model,
-      };
-    }
+      if (result.valid) {
+        return {
+          valid: true as const,
+          workflow_document: result.definition.document,
+          workflow_model: result.definition.model,
+        };
+      }
 
-    return result;
-  },
-});
+      return result;
+    },
+  });
+}

package/src/temporal/activities/sync-activities.test.ts

@@ -1,13 +1,16 @@
 import type {IntegrationSourceControlService} from '@shipfox/api-integration-core';
-import {integrationsInterModuleContract} from '@shipfox/api-integration-core-dto';
+import {integrationsInterModuleContract} from '@shipfox/api-integration-core-dto/inter-module';
 import {createInterModuleKnownError} from '@shipfox/inter-module';
 import {isErrorReported} from '@shipfox/node-error-monitoring';
 import {ApplicationFailure} from '@temporalio/common';
 import {sql} from 'drizzle-orm';
 import {db, definitionSyncStates} from '#db/index.js';
 import {workflowDefinitions} from '#db/schema/definitions.js';
+import {agentValidationCatalog} from '#test/agent-validation-catalog.js';
 import {createDefinitionSyncActivities} from './sync-activities.js';
 
+const agent = {getValidationCatalog: vi.fn(() => agentValidationCatalog)} as never;
+
 vi.mock('@temporalio/activity', () => ({
   Context: {
     current: () => ({heartbeat: vi.fn()}),
@@ -79,7 +82,7 @@ describe('definition sync activities', () => {
 
   describe('prepareDefinitionSync', () => {
     it('marks the sync state as syncing and returns the resolved ref', async () => {
-      const activities = createDefinitionSyncActivities(sourceControl());
+      const activities = createDefinitionSyncActivities(sourceControl(), agent);
 
       const result = await activities.prepareDefinitionSync({
         projectId,
@@ -100,7 +103,7 @@ describe('definition sync activities', () => {
 
     it('keeps source ref and source commit sha separate for commit-triggered sync', async () => {
       const source = sourceControl();
-      const activities = createDefinitionSyncActivities(source);
+      const activities = createDefinitionSyncActivities(source, agent);
 
       const result = await activities.prepareDefinitionSync({
         projectId,
@@ -127,6 +130,7 @@ describe('definition sync activities', () => {
             return Promise.reject(new Error('temporary outage'));
           }),
         }),
+        agent,
       );
 
       const result = activities.prepareDefinitionSync({
@@ -159,6 +163,7 @@ describe('definition sync activities', () => {
             );
           }),
         }),
+        agent,
       );
 
       const result = activities.prepareDefinitionSync({
@@ -180,7 +185,7 @@ describe('definition sync activities', () => {
 
   describe('fetchAndApplyDefinitionWorkflows', () => {
     it('upserts workflow definitions and soft-deletes orphans', async () => {
-      const activities = createDefinitionSyncActivities(sourceControl());
+      const activities = createDefinitionSyncActivities(sourceControl(), agent);
 
       const result = await activities.fetchAndApplyDefinitionWorkflows({
         projectId,
@@ -206,6 +211,7 @@ describe('definition sync activities', () => {
             }),
           ),
         }),
+        agent,
       );
 
       const result = activities.fetchAndApplyDefinitionWorkflows({
@@ -224,7 +230,7 @@ describe('definition sync activities', () => {
 
     it('fetches from source commit sha while persisting under source ref', async () => {
       const source = sourceControl();
-      const activities = createDefinitionSyncActivities(source);
+      const activities = createDefinitionSyncActivities(source, agent);
 
       const result = await activities.fetchAndApplyDefinitionWorkflows({
         projectId,
@@ -250,7 +256,7 @@ describe('definition sync activities', () => {
 
   describe('markDefinitionSyncFailed', () => {
     it('persists last_error_code and last_error_message verbatim', async () => {
-      const activities = createDefinitionSyncActivities(sourceControl());
+      const activities = createDefinitionSyncActivities(sourceControl(), agent);
       await activities.prepareDefinitionSync({
         projectId,
         workspaceId: crypto.randomUUID(),
@@ -280,7 +286,7 @@ describe('definition sync activities', () => {
     });
 
     it('persists failures with the unresolved sentinel ref when no ref was produced', async () => {
-      const activities = createDefinitionSyncActivities(sourceControl());
+      const activities = createDefinitionSyncActivities(sourceControl(), agent);
 
       const result = activities.markDefinitionSyncFailed({
         projectId,
@@ -307,7 +313,7 @@ describe('definition sync activities', () => {
 
   describe('markDefinitionSyncSucceeded', () => {
     it('clears stale error fields when transitioning to succeeded', async () => {
-      const activities = createDefinitionSyncActivities(sourceControl());
+      const activities = createDefinitionSyncActivities(sourceControl(), agent);
       await activities.prepareDefinitionSync({
         projectId,
         workspaceId: crypto.randomUUID(),

package/src/temporal/activities/sync-activities.ts

@@ -1,4 +1,5 @@
-import type {IntegrationsModuleClient} from '@shipfox/api-integration-core-dto';
+import type {AgentInterModuleClient} from '@shipfox/api-agent-dto/inter-module';
+import type {IntegrationsModuleClient} from '@shipfox/api-integration-core-dto/inter-module';
 import {markErrorReported} from '@shipfox/node-error-monitoring';
 import {Context} from '@temporalio/activity';
 import {ApplicationFailure} from '@temporalio/common';
@@ -53,12 +54,17 @@ export interface FetchAndApplyActivityResult {
 
 export function createDefinitionSyncActivities(
   sourceControl: DefinitionsSourceControl,
+  agent: AgentInterModuleClient,
   integrations?: IntegrationsModuleClient | undefined,
 ) {
   return {
     prepareDefinitionSync: createPrepareDefinitionSyncActivity(sourceControl),
     discoverDefinitionWorkflows: createDiscoverDefinitionWorkflowsActivity(sourceControl),
-    fetchAndApplyDefinitionWorkflows: createFetchAndApplyActivity(sourceControl, integrations),
+    fetchAndApplyDefinitionWorkflows: createFetchAndApplyActivity(
+      sourceControl,
+      agent,
+      integrations,
+    ),
     markDefinitionSyncSucceeded: createMarkSyncSucceededActivity(),
     markDefinitionSyncFailed: createMarkSyncFailedActivity(),
   };
@@ -104,6 +110,7 @@ function createDiscoverDefinitionWorkflowsActivity(sourceControl: DefinitionsSou
 
 function createFetchAndApplyActivity(
   sourceControl: DefinitionsSourceControl,
+  agent: AgentInterModuleClient,
   integrations?: IntegrationsModuleClient | undefined,
 ) {
   return async function fetchAndApplyDefinitionWorkflows(
@@ -114,6 +121,7 @@ function createFetchAndApplyActivity(
         ...input,
         ref: input.sourceCommitSha ?? input.sourceRef,
         sourceControl,
+        agentValidationCatalog: await agent.getValidationCatalog({}),
         onProgress: (path) => Context.current().heartbeat({path}),
         loadIntegrationValidationContext:
           integrations === undefined

package/test/agent-validation-catalog.ts

@@ -0,0 +1,25 @@
+import {
+  DEFAULT_HARNESS_TOOL_DEPLOYMENT_CONFIG,
+  getModelProviderEntry,
+  listEnabledHarnessTools,
+  listHarnessDescriptors,
+  MODEL_PROVIDER_IDS,
+} from '@shipfox/api-agent-dto';
+import type {AgentValidationCatalog} from '@shipfox/api-agent-dto/inter-module';
+
+export const agentValidationCatalog: AgentValidationCatalog = {
+  version: 1,
+  providers: MODEL_PROVIDER_IDS.map((id) => ({
+    id,
+    support_status: getModelProviderEntry(id)?.support_status ?? 'unsupported',
+  })),
+  harnesses: listHarnessDescriptors().map((harness) => ({
+    id: harness.id,
+    supported_provider_ids: [...harness.supportedProviderIds],
+    thinking_levels: [...harness.thinkingLevels],
+    effective_tools: listEnabledHarnessTools(
+      harness.id,
+      DEFAULT_HARNESS_TOOL_DEPLOYMENT_CONFIG,
+    ).map((tool) => tool.name),
+  })),
+};

package/test/factories/definition.ts

@@ -5,6 +5,7 @@ import type {
 } from '#core/entities/workflow-definition.js';
 import {normalizeWorkflowDocument} from '#core/workflow-model/index.js';
 import {upsertDefinition} from '#db/definitions.js';
+import {agentValidationCatalog} from '#test/agent-validation-catalog.js';
 
 function defaultDefinition(): WorkflowDefinitionPayload {
   const document = {
@@ -16,7 +17,7 @@ function defaultDefinition(): WorkflowDefinitionPayload {
       },
     },
   };
-  return {document, model: normalizeWorkflowDocument(document)};
+  return {document, model: normalizeWorkflowDocument(document, {agentValidationCatalog})};
 }
 
 interface DefinitionTransients {