@shipfox/api-definitions 11.0.0 → 12.0.0

package/drizzle/0002_lumpy_ben_parker.sql

@@ -0,0 +1 @@
+ALTER TABLE "definitions_sync_states" ADD COLUMN "warnings" jsonb DEFAULT '[]'::jsonb NOT NULL;

package/drizzle/meta/0002_snapshot.json

@@ -0,0 +1,534 @@
+{
+  "id": "e5dff42f-09f1-4a29-973f-b0d63a150673",
+  "prevId": "a20924e2-d7b1-4f98-b8c4-bab54ea48de5",
+  "version": "7",
+  "dialect": "postgresql",
+  "tables": {
+    "public.definitions_workflow_definitions": {
+      "name": "definitions_workflow_definitions",
+      "schema": "",
+      "columns": {
+        "id": {
+          "name": "id",
+          "type": "uuid",
+          "primaryKey": true,
+          "notNull": true,
+          "default": "uuidv7()"
+        },
+        "project_id": {
+          "name": "project_id",
+          "type": "uuid",
+          "primaryKey": false,
+          "notNull": true
+        },
+        "config_path": {
+          "name": "config_path",
+          "type": "text",
+          "primaryKey": false,
+          "notNull": false
+        },
+        "source": {
+          "name": "source",
+          "type": "definitions_source",
+          "typeSchema": "public",
+          "primaryKey": false,
+          "notNull": true,
+          "default": "'manual'"
+        },
+        "sha": {
+          "name": "sha",
+          "type": "text",
+          "primaryKey": false,
+          "notNull": false
+        },
+        "ref": {
+          "name": "ref",
+          "type": "text",
+          "primaryKey": false,
+          "notNull": false
+        },
+        "name": {
+          "name": "name",
+          "type": "text",
+          "primaryKey": false,
+          "notNull": true
+        },
+        "definition": {
+          "name": "definition",
+          "type": "jsonb",
+          "primaryKey": false,
+          "notNull": true
+        },
+        "content_hash": {
+          "name": "content_hash",
+          "type": "text",
+          "primaryKey": false,
+          "notNull": false
+        },
+        "fetched_at": {
+          "name": "fetched_at",
+          "type": "timestamp with time zone",
+          "primaryKey": false,
+          "notNull": true,
+          "default": "now()"
+        },
+        "created_at": {
+          "name": "created_at",
+          "type": "timestamp with time zone",
+          "primaryKey": false,
+          "notNull": true,
+          "default": "now()"
+        },
+        "updated_at": {
+          "name": "updated_at",
+          "type": "timestamp with time zone",
+          "primaryKey": false,
+          "notNull": true,
+          "default": "now()"
+        },
+        "deleted_at": {
+          "name": "deleted_at",
+          "type": "timestamp with time zone",
+          "primaryKey": false,
+          "notNull": false
+        }
+      },
+      "indexes": {
+        "definitions_wd_manual_unique": {
+          "name": "definitions_wd_manual_unique",
+          "columns": [
+            {
+              "expression": "project_id",
+              "isExpression": false,
+              "asc": true,
+              "nulls": "last"
+            },
+            {
+              "expression": "config_path",
+              "isExpression": false,
+              "asc": true,
+              "nulls": "last"
+            }
+          ],
+          "isUnique": true,
+          "where": "\"config_path\" IS NOT NULL AND \"ref\" IS NULL AND \"sha\" IS NULL",
+          "concurrently": false,
+          "method": "btree",
+          "with": {}
+        },
+        "definitions_wd_sha_lookup": {
+          "name": "definitions_wd_sha_lookup",
+          "columns": [
+            {
+              "expression": "project_id",
+              "isExpression": false,
+              "asc": true,
+              "nulls": "last"
+            },
+            {
+              "expression": "sha",
+              "isExpression": false,
+              "asc": true,
+              "nulls": "last"
+            },
+            {
+              "expression": "config_path",
+              "isExpression": false,
+              "asc": true,
+              "nulls": "last"
+            }
+          ],
+          "isUnique": true,
+          "where": "\"sha\" IS NOT NULL",
+          "concurrently": false,
+          "method": "btree",
+          "with": {}
+        },
+        "definitions_wd_ref_lookup": {
+          "name": "definitions_wd_ref_lookup",
+          "columns": [
+            {
+              "expression": "project_id",
+              "isExpression": false,
+              "asc": true,
+              "nulls": "last"
+            },
+            {
+              "expression": "ref",
+              "isExpression": false,
+              "asc": true,
+              "nulls": "last"
+            },
+            {
+              "expression": "config_path",
+              "isExpression": false,
+              "asc": true,
+              "nulls": "last"
+            }
+          ],
+          "isUnique": true,
+          "where": "\"ref\" IS NOT NULL",
+          "concurrently": false,
+          "method": "btree",
+          "with": {}
+        },
+        "definitions_wd_project_name_id_idx": {
+          "name": "definitions_wd_project_name_id_idx",
+          "columns": [
+            {
+              "expression": "project_id",
+              "isExpression": false,
+              "asc": true,
+              "nulls": "last"
+            },
+            {
+              "expression": "name",
+              "isExpression": false,
+              "asc": true,
+              "nulls": "last"
+            },
+            {
+              "expression": "id",
+              "isExpression": false,
+              "asc": true,
+              "nulls": "last"
+            }
+          ],
+          "isUnique": false,
+          "where": "\"deleted_at\" IS NULL",
+          "concurrently": false,
+          "method": "btree",
+          "with": {}
+        }
+      },
+      "foreignKeys": {},
+      "compositePrimaryKeys": {},
+      "uniqueConstraints": {},
+      "policies": {},
+      "checkConstraints": {
+        "definitions_wd_source_ref_sha_consistent": {
+          "name": "definitions_wd_source_ref_sha_consistent",
+          "value": "(\"source\" = 'vcs') = (\"ref\" IS NOT NULL OR \"sha\" IS NOT NULL)"
+        }
+      },
+      "isRLSEnabled": false
+    },
+    "public.definitions_outbox": {
+      "name": "definitions_outbox",
+      "schema": "",
+      "columns": {
+        "id": {
+          "name": "id",
+          "type": "uuid",
+          "primaryKey": true,
+          "notNull": true,
+          "default": "uuidv7()"
+        },
+        "event_type": {
+          "name": "event_type",
+          "type": "text",
+          "primaryKey": false,
+          "notNull": true
+        },
+        "ordering_key": {
+          "name": "ordering_key",
+          "type": "text",
+          "primaryKey": false,
+          "notNull": false
+        },
+        "payload": {
+          "name": "payload",
+          "type": "jsonb",
+          "primaryKey": false,
+          "notNull": true
+        },
+        "created_at": {
+          "name": "created_at",
+          "type": "timestamp with time zone",
+          "primaryKey": false,
+          "notNull": true,
+          "default": "now()"
+        },
+        "dispatched_at": {
+          "name": "dispatched_at",
+          "type": "timestamp with time zone",
+          "primaryKey": false,
+          "notNull": false
+        },
+        "dispatch_attempts": {
+          "name": "dispatch_attempts",
+          "type": "integer",
+          "primaryKey": false,
+          "notNull": true,
+          "default": 0
+        },
+        "next_dispatch_at": {
+          "name": "next_dispatch_at",
+          "type": "timestamp with time zone",
+          "primaryKey": false,
+          "notNull": true,
+          "default": "now()"
+        },
+        "last_dispatch_error": {
+          "name": "last_dispatch_error",
+          "type": "jsonb",
+          "primaryKey": false,
+          "notNull": false
+        },
+        "last_dispatch_failed_at": {
+          "name": "last_dispatch_failed_at",
+          "type": "timestamp with time zone",
+          "primaryKey": false,
+          "notNull": false
+        },
+        "dead_lettered_at": {
+          "name": "dead_lettered_at",
+          "type": "timestamp with time zone",
+          "primaryKey": false,
+          "notNull": false
+        }
+      },
+      "indexes": {
+        "definitions_outbox_pending_idx": {
+          "name": "definitions_outbox_pending_idx",
+          "columns": [
+            {
+              "expression": "next_dispatch_at",
+              "isExpression": false,
+              "asc": true,
+              "nulls": "last"
+            },
+            {
+              "expression": "created_at",
+              "isExpression": false,
+              "asc": true,
+              "nulls": "last"
+            }
+          ],
+          "isUnique": false,
+          "where": "\"dispatched_at\" IS NULL AND \"dead_lettered_at\" IS NULL",
+          "concurrently": false,
+          "method": "btree",
+          "with": {}
+        },
+        "definitions_outbox_dispatched_retention_idx": {
+          "name": "definitions_outbox_dispatched_retention_idx",
+          "columns": [
+            {
+              "expression": "dispatched_at",
+              "isExpression": false,
+              "asc": true,
+              "nulls": "last"
+            },
+            {
+              "expression": "id",
+              "isExpression": false,
+              "asc": true,
+              "nulls": "last"
+            }
+          ],
+          "isUnique": false,
+          "where": "\"dispatched_at\" IS NOT NULL",
+          "concurrently": false,
+          "method": "btree",
+          "with": {}
+        }
+      },
+      "foreignKeys": {},
+      "compositePrimaryKeys": {},
+      "uniqueConstraints": {},
+      "policies": {},
+      "checkConstraints": {},
+      "isRLSEnabled": false
+    },
+    "public.definitions_sync_states": {
+      "name": "definitions_sync_states",
+      "schema": "",
+      "columns": {
+        "id": {
+          "name": "id",
+          "type": "uuid",
+          "primaryKey": true,
+          "notNull": true,
+          "default": "uuidv7()"
+        },
+        "project_id": {
+          "name": "project_id",
+          "type": "uuid",
+          "primaryKey": false,
+          "notNull": true
+        },
+        "source_connection_id": {
+          "name": "source_connection_id",
+          "type": "uuid",
+          "primaryKey": false,
+          "notNull": true
+        },
+        "source_external_repository_id": {
+          "name": "source_external_repository_id",
+          "type": "text",
+          "primaryKey": false,
+          "notNull": true
+        },
+        "ref": {
+          "name": "ref",
+          "type": "text",
+          "primaryKey": false,
+          "notNull": true
+        },
+        "status": {
+          "name": "status",
+          "type": "definitions_sync_status",
+          "typeSchema": "public",
+          "primaryKey": false,
+          "notNull": true,
+          "default": "'pending'"
+        },
+        "last_error_code": {
+          "name": "last_error_code",
+          "type": "definitions_sync_error_code",
+          "typeSchema": "public",
+          "primaryKey": false,
+          "notNull": false
+        },
+        "last_error_message": {
+          "name": "last_error_message",
+          "type": "text",
+          "primaryKey": false,
+          "notNull": false
+        },
+        "warnings": {
+          "name": "warnings",
+          "type": "jsonb",
+          "primaryKey": false,
+          "notNull": true,
+          "default": "'[]'::jsonb"
+        },
+        "started_at": {
+          "name": "started_at",
+          "type": "timestamp with time zone",
+          "primaryKey": false,
+          "notNull": false
+        },
+        "finished_at": {
+          "name": "finished_at",
+          "type": "timestamp with time zone",
+          "primaryKey": false,
+          "notNull": false
+        },
+        "created_at": {
+          "name": "created_at",
+          "type": "timestamp with time zone",
+          "primaryKey": false,
+          "notNull": true,
+          "default": "now()"
+        },
+        "updated_at": {
+          "name": "updated_at",
+          "type": "timestamp with time zone",
+          "primaryKey": false,
+          "notNull": true,
+          "default": "now()"
+        }
+      },
+      "indexes": {
+        "definitions_sync_states_source_unique": {
+          "name": "definitions_sync_states_source_unique",
+          "columns": [
+            {
+              "expression": "project_id",
+              "isExpression": false,
+              "asc": true,
+              "nulls": "last"
+            },
+            {
+              "expression": "source_connection_id",
+              "isExpression": false,
+              "asc": true,
+              "nulls": "last"
+            },
+            {
+              "expression": "source_external_repository_id",
+              "isExpression": false,
+              "asc": true,
+              "nulls": "last"
+            },
+            {
+              "expression": "ref",
+              "isExpression": false,
+              "asc": true,
+              "nulls": "last"
+            }
+          ],
+          "isUnique": true,
+          "concurrently": false,
+          "method": "btree",
+          "with": {}
+        },
+        "definitions_sync_states_failed_idx": {
+          "name": "definitions_sync_states_failed_idx",
+          "columns": [
+            {
+              "expression": "updated_at",
+              "isExpression": false,
+              "asc": true,
+              "nulls": "last"
+            }
+          ],
+          "isUnique": false,
+          "where": "\"status\" = 'failed'",
+          "concurrently": false,
+          "method": "btree",
+          "with": {}
+        }
+      },
+      "foreignKeys": {},
+      "compositePrimaryKeys": {},
+      "uniqueConstraints": {},
+      "policies": {},
+      "checkConstraints": {},
+      "isRLSEnabled": false
+    }
+  },
+  "enums": {
+    "public.definitions_source": {
+      "name": "definitions_source",
+      "schema": "public",
+      "values": ["manual", "vcs"]
+    },
+    "public.definitions_sync_error_code": {
+      "name": "definitions_sync_error_code",
+      "schema": "public",
+      "values": [
+        "no-workflow-files",
+        "invalid-definition",
+        "provider-repository-not-found",
+        "provider-file-not-found",
+        "provider-access-denied",
+        "provider-rate-limited",
+        "provider-timeout",
+        "provider-unavailable",
+        "provider-malformed-response",
+        "content-too-large",
+        "too-many-files",
+        "connection-unavailable",
+        "unknown"
+      ]
+    },
+    "public.definitions_sync_status": {
+      "name": "definitions_sync_status",
+      "schema": "public",
+      "values": ["pending", "syncing", "succeeded", "failed"]
+    }
+  },
+  "schemas": {},
+  "sequences": {},
+  "roles": {},
+  "policies": {},
+  "views": {},
+  "_meta": {
+    "columns": {},
+    "schemas": {},
+    "tables": {}
+  }
+}

package/drizzle/meta/_journal.json

@@ -15,6 +15,13 @@
       "when": 1778494690000,
       "tag": "0001_definition_list_pagination",
       "breakpoints": true
+    },
+    {
+      "idx": 2,
+      "version": "7",
+      "when": 1785415305913,
+      "tag": "0002_lumpy_ben_parker",
+      "breakpoints": true
     }
   ]
 }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@shipfox/api-definitions",
   "license": "MIT",
-  "version": "11.0.0",
+  "version": "12.0.0",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/ShipfoxHQ/shipfox.git",
@@ -26,25 +26,25 @@
     "js-yaml": "^4.1.0",
     "yaml": "^2.8.3",
     "zod": "^4.4.3",
-    "@shipfox/api-agent-dto": "10.0.0",
-    "@shipfox/api-auth-context": "11.0.0",
-    "@shipfox/api-definitions-dto": "11.0.0",
-    "@shipfox/api-integration-core-dto": "9.0.2",
-    "@shipfox/api-projects-dto": "10.1.0",
-    "@shipfox/api-secrets-dto": "9.0.2",
+    "@shipfox/api-agent-dto": "12.0.0",
+    "@shipfox/api-auth-context": "12.0.0",
+    "@shipfox/api-definitions-dto": "12.0.0",
+    "@shipfox/api-integration-core-dto": "12.0.0",
+    "@shipfox/api-projects-dto": "12.0.0",
+    "@shipfox/api-secrets-dto": "12.0.0",
     "@shipfox/config": "1.2.4",
-    "@shipfox/expression": "1.2.1",
-    "@shipfox/inter-module": "0.2.2",
-    "@shipfox/node-drizzle": "0.3.4",
-    "@shipfox/node-fastify": "0.4.0",
+    "@shipfox/expression": "2.0.0",
+    "@shipfox/inter-module": "0.2.3",
+    "@shipfox/node-drizzle": "0.3.5",
+    "@shipfox/node-fastify": "0.4.1",
     "@shipfox/node-error-monitoring": "0.3.0",
-    "@shipfox/node-module": "1.0.4",
+    "@shipfox/node-module": "1.0.5",
     "@shipfox/node-opentelemetry": "0.6.3",
     "@shipfox/node-outbox": "0.2.6",
-    "@shipfox/node-postgres": "0.4.4",
+    "@shipfox/node-postgres": "0.5.0",
     "@shipfox/node-temporal": "0.4.4",
     "@shipfox/runner-labels": "0.1.3",
-    "@shipfox/workflow-document": "2.1.3"
+    "@shipfox/workflow-document": "3.0.0"
   },
   "imports": {
     "#*": "./dist/*"

package/src/core/entities/index.ts

@@ -1,4 +1,5 @@
 export * from './integration-context.js';
 export * from './sync-state.js';
+export * from './validation-warning.js';
 export * from './workflow-definition.js';
 export * from './workflow-model.js';

package/src/core/entities/sync-state.ts

@@ -1,5 +1,27 @@
+import {
+  DEFINITION_SYNC_WARNING_CODE_MAX_LENGTH,
+  DEFINITION_SYNC_WARNING_MESSAGE_MAX_LENGTH,
+  DEFINITION_SYNC_WARNING_PATH_MAX_LENGTH,
+  DEFINITION_SYNC_WARNINGS_MAX_COUNT,
+} from '@shipfox/api-definitions-dto';
+import type {ValidationWarning} from './validation-warning.js';
+
 export type DefinitionSyncStatus = 'pending' | 'syncing' | 'succeeded' | 'failed';
 
+export type DefinitionSyncWarning = ValidationWarning;
+
+export function limitDefinitionSyncWarnings(
+  warnings: readonly DefinitionSyncWarning[],
+): DefinitionSyncWarning[] {
+  return warnings.slice(0, DEFINITION_SYNC_WARNINGS_MAX_COUNT).map((warning) => ({
+    code: warning.code.slice(0, DEFINITION_SYNC_WARNING_CODE_MAX_LENGTH),
+    message: warning.message.slice(0, DEFINITION_SYNC_WARNING_MESSAGE_MAX_LENGTH),
+    ...(warning.path === undefined
+      ? {}
+      : {path: warning.path.slice(0, DEFINITION_SYNC_WARNING_PATH_MAX_LENGTH)}),
+  }));
+}
+
 export const DEFINITION_SYNC_ERROR_CODES = [
   'no-workflow-files',
   'invalid-definition',
@@ -33,6 +55,7 @@ export interface DefinitionSyncState {
   status: DefinitionSyncStatus;
   lastErrorCode: DefinitionSyncErrorCode | null;
   lastErrorMessage: string | null;
+  warnings: DefinitionSyncWarning[];
   startedAt: Date | null;
   finishedAt: Date | null;
   createdAt: Date;

package/src/core/entities/validation-warning.ts

@@ -0,0 +1,5 @@
+export interface ValidationWarning {
+  code: string;
+  message: string;
+  path?: string | undefined;
+}

package/src/core/parse-definition-warnings.test.ts

@@ -0,0 +1,33 @@
+import {agentValidationCatalog} from '#test/agent-validation-catalog.js';
+import {parseDefinitionWithWarnings} from './parse-definition.js';
+import {validateDefinition} from './validate-definition.js';
+
+vi.mock('./validate-definition.js', () => ({
+  validateDefinition: vi.fn(),
+}));
+
+describe('parseDefinitionWithWarnings', () => {
+  it('returns warnings from successful validation', () => {
+    vi.mocked(validateDefinition).mockReturnValue({
+      valid: true,
+      definition: {document: {}, model: {}} as never,
+      warnings: [
+        {
+          code: 'synthetic-warning',
+          message: 'A non-fatal validation warning',
+          path: 'jobs.build.steps.0.run',
+        },
+      ],
+    });
+
+    const parsed = parseDefinitionWithWarnings('name: Workflow', {agentValidationCatalog});
+
+    expect(parsed.warnings).toEqual([
+      {
+        code: 'synthetic-warning',
+        message: 'A non-fatal validation warning',
+        path: 'jobs.build.steps.0.run',
+      },
+    ]);
+  });
+});