@shipfox/api-agent 8.0.0 → 9.0.2

package/drizzle/0000_daffy_leopardon.sql

@@ -1,9 +1,9 @@
-CREATE TYPE "public"."model_provider_config_kind" AS ENUM('builtin', 'custom');--> statement-breakpoint
-CREATE TABLE "model_provider_configs" (
+CREATE TYPE "public"."agent_model_provider_config_kind" AS ENUM('builtin', 'custom');--> statement-breakpoint
+CREATE TABLE "agent_model_provider_configs" (
 	"id" uuid PRIMARY KEY DEFAULT uuidv7() NOT NULL,
 	"workspace_id" uuid NOT NULL,
 	"provider_id" text NOT NULL,
-	"kind" "model_provider_config_kind" DEFAULT 'builtin' NOT NULL,
+	"kind" "agent_model_provider_config_kind" DEFAULT 'builtin' NOT NULL,
 	"display_name" text,
 	"api" text,
 	"base_url" text,
@@ -15,7 +15,7 @@ CREATE TABLE "model_provider_configs" (
 	"default_thinking" text NOT NULL,
 	"created_at" timestamp with time zone DEFAULT now() NOT NULL,
 	"updated_at" timestamp with time zone DEFAULT now() NOT NULL,
-	CONSTRAINT "model_provider_configs_custom_required_fields" CHECK ("kind" <> 'custom' OR ("api" IS NOT NULL AND "base_url" IS NOT NULL AND "models" IS NOT NULL AND "display_name" IS NOT NULL))
+	CONSTRAINT "agent_model_provider_configs_custom_required_fields" CHECK ("kind" <> 'custom' OR ("api" IS NOT NULL AND "base_url" IS NOT NULL AND "models" IS NOT NULL AND "display_name" IS NOT NULL))
 );
 --> statement-breakpoint
 CREATE TABLE "agent_workspace_settings" (
@@ -25,4 +25,4 @@ CREATE TABLE "agent_workspace_settings" (
 	"updated_at" timestamp with time zone DEFAULT now() NOT NULL
 );
 --> statement-breakpoint
-CREATE UNIQUE INDEX "model_provider_configs_workspace_provider_unique" ON "model_provider_configs" USING btree ("workspace_id","provider_id");
+CREATE UNIQUE INDEX "agent_model_provider_configs_workspace_provider_unique" ON "agent_model_provider_configs" USING btree ("workspace_id","provider_id");

package/drizzle/meta/0000_snapshot.json

@@ -4,8 +4,8 @@
   "version": "7",
   "dialect": "postgresql",
   "tables": {
-    "public.model_provider_configs": {
-      "name": "model_provider_configs",
+    "public.agent_model_provider_configs": {
+      "name": "agent_model_provider_configs",
       "schema": "",
       "columns": {
         "id": {
@@ -29,7 +29,7 @@
         },
         "kind": {
           "name": "kind",
-          "type": "model_provider_config_kind",
+          "type": "agent_model_provider_config_kind",
           "primaryKey": false,
           "notNull": true,
           "default": "'builtin'"
@@ -105,8 +105,8 @@
         }
       },
       "indexes": {
-        "model_provider_configs_workspace_provider_unique": {
-          "name": "model_provider_configs_workspace_provider_unique",
+        "agent_model_provider_configs_workspace_provider_unique": {
+          "name": "agent_model_provider_configs_workspace_provider_unique",
           "columns": [
             {
               "expression": "workspace_id",
@@ -132,9 +132,9 @@
       "uniqueConstraints": {},
       "policies": {},
       "checkConstraints": {
-        "model_provider_configs_custom_required_fields": {
-          "name": "model_provider_configs_custom_required_fields",
-          "value": "\"model_provider_configs\".\"kind\" <> 'custom' OR (\"model_provider_configs\".\"api\" IS NOT NULL AND \"model_provider_configs\".\"base_url\" IS NOT NULL AND \"model_provider_configs\".\"models\" IS NOT NULL AND \"model_provider_configs\".\"display_name\" IS NOT NULL)"
+        "agent_model_provider_configs_custom_required_fields": {
+          "name": "agent_model_provider_configs_custom_required_fields",
+          "value": "\"agent_model_provider_configs\".\"kind\" <> 'custom' OR (\"agent_model_provider_configs\".\"api\" IS NOT NULL AND \"agent_model_provider_configs\".\"base_url\" IS NOT NULL AND \"agent_model_provider_configs\".\"models\" IS NOT NULL AND \"agent_model_provider_configs\".\"display_name\" IS NOT NULL)"
         }
       },
       "isRLSEnabled": false
@@ -180,8 +180,8 @@
     }
   },
   "enums": {
-    "public.model_provider_config_kind": {
-      "name": "model_provider_config_kind",
+    "public.agent_model_provider_config_kind": {
+      "name": "agent_model_provider_config_kind",
       "schema": "public",
       "values": ["builtin", "custom"]
     }

package/drizzle/meta/0001_snapshot.json

@@ -4,8 +4,8 @@
   "version": "7",
   "dialect": "postgresql",
   "tables": {
-    "public.model_provider_configs": {
-      "name": "model_provider_configs",
+    "public.agent_model_provider_configs": {
+      "name": "agent_model_provider_configs",
       "schema": "",
       "columns": {
         "id": {
@@ -29,7 +29,7 @@
         },
         "kind": {
           "name": "kind",
-          "type": "model_provider_config_kind",
+          "type": "agent_model_provider_config_kind",
           "primaryKey": false,
           "notNull": true,
           "default": "'builtin'"
@@ -105,8 +105,8 @@
         }
       },
       "indexes": {
-        "model_provider_configs_workspace_provider_unique": {
-          "name": "model_provider_configs_workspace_provider_unique",
+        "agent_model_provider_configs_workspace_provider_unique": {
+          "name": "agent_model_provider_configs_workspace_provider_unique",
           "columns": [
             {
               "expression": "workspace_id",
@@ -132,9 +132,9 @@
       "uniqueConstraints": {},
       "policies": {},
       "checkConstraints": {
-        "model_provider_configs_custom_required_fields": {
-          "name": "model_provider_configs_custom_required_fields",
-          "value": "\"model_provider_configs\".\"kind\" <> 'custom' OR (\"model_provider_configs\".\"api\" IS NOT NULL AND \"model_provider_configs\".\"base_url\" IS NOT NULL AND \"model_provider_configs\".\"models\" IS NOT NULL AND \"model_provider_configs\".\"display_name\" IS NOT NULL)"
+        "agent_model_provider_configs_custom_required_fields": {
+          "name": "agent_model_provider_configs_custom_required_fields",
+          "value": "\"agent_model_provider_configs\".\"kind\" <> 'custom' OR (\"agent_model_provider_configs\".\"api\" IS NOT NULL AND \"agent_model_provider_configs\".\"base_url\" IS NOT NULL AND \"agent_model_provider_configs\".\"models\" IS NOT NULL AND \"agent_model_provider_configs\".\"display_name\" IS NOT NULL)"
         }
       },
       "isRLSEnabled": false
@@ -186,8 +186,8 @@
     }
   },
   "enums": {
-    "public.model_provider_config_kind": {
-      "name": "model_provider_config_kind",
+    "public.agent_model_provider_config_kind": {
+      "name": "agent_model_provider_config_kind",
       "schema": "public",
       "values": ["builtin", "custom"]
     }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@shipfox/api-agent",
   "license": "MIT",
-  "version": "8.0.0",
+  "version": "9.0.2",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/ShipfoxHQ/shipfox.git",
@@ -11,10 +11,6 @@
   "type": "module",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
-  "imports": {
-    "#test/*": "./test/*",
-    "#*": "./dist/*"
-  },
   "exports": {
     ".": {
       "types": "./dist/index.d.ts",
@@ -42,19 +38,30 @@
     "@opentelemetry/api": "^1.9.1",
     "drizzle-orm": "^0.45.2",
     "zod": "^4.4.3",
-    "@shipfox/node-error-monitoring": "0.2.0",
-    "@shipfox/api-agent-dto": "8.0.0",
-    "@shipfox/api-auth-context": "7.1.0",
-    "@shipfox/api-secrets-dto": "6.0.0",
-    "@shipfox/inter-module": "0.2.0",
-    "@shipfox/config": "1.2.2",
-    "@shipfox/node-drizzle": "0.3.2",
-    "@shipfox/node-egress-guard": "0.1.1",
-    "@shipfox/node-fastify": "0.3.0",
-    "@shipfox/node-module": "0.5.0",
-    "@shipfox/node-opentelemetry": "0.6.0",
-    "@shipfox/node-postgres": "0.4.2",
-    "@shipfox/redact": "0.2.3"
+    "@shipfox/node-error-monitoring": "0.2.2",
+    "@shipfox/api-agent-dto": "9.0.2",
+    "@shipfox/api-auth-context": "9.0.2",
+    "@shipfox/api-secrets-dto": "9.0.2",
+    "@shipfox/inter-module": "0.2.2",
+    "@shipfox/config": "1.2.4",
+    "@shipfox/node-drizzle": "0.3.4",
+    "@shipfox/node-egress-guard": "0.1.3",
+    "@shipfox/node-fastify": "0.3.2",
+    "@shipfox/node-module": "1.0.1",
+    "@shipfox/node-opentelemetry": "0.6.2",
+    "@shipfox/node-postgres": "0.4.4",
+    "@shipfox/redact": "0.2.5"
+  },
+  "imports": {
+    "#*": "./dist/*"
+  },
+  "shipfox": {
+    "architecture": {
+      "schema": 1,
+      "realm": "source-available",
+      "kind": "implementation",
+      "context": "agent"
+    }
   },
   "scripts": {
     "build": "shipfox-swc",

package/src/config.ts

@@ -1,11 +1,11 @@
 import {
   agentThinkingSchema,
   buildHarnessToolDeploymentConfig,
-  getModelProviderEntry,
   SUPPORTED_MODEL_PROVIDER_IDS,
   type SupportedModelProviderId,
 } from '@shipfox/api-agent-dto';
 import {bool, createConfig, num, str} from '@shipfox/config';
+import {getModelProviderEntry} from '#core/model-provider-policy.js';
 
 const AGENT_THINKING_CHOICES = agentThinkingSchema.options;
 

package/src/core/catalog-registry.test.ts

@@ -1,11 +1,11 @@
 import {getModels, getProviders, type KnownProvider} from '@earendil-works/pi-ai';
 import {
-  getModelProviderEntry,
   MODEL_PROVIDER_CATALOG_SEED,
   MODEL_PROVIDER_IDS,
   type ModelProviderId,
   SUPPORTED_MODEL_PROVIDER_IDS,
 } from '@shipfox/api-agent-dto';
+import {getModelProviderEntry, isReservedModelProviderId} from './model-provider-policy.js';
 
 const STORE_COMPATIBLE_CREDENTIAL_KEY_PATTERN = /^[a-z_][a-z0-9_]*$/;
 
@@ -17,6 +17,13 @@ describe('model provider catalog registry', () => {
     expect(catalogModelProviderIds).toEqual(piModelProviderIds);
   });
 
+  it('keeps the Agent reserved-provider helper aligned with every known provider ID', () => {
+    const reservedProviderIds = MODEL_PROVIDER_IDS.filter(isReservedModelProviderId).sort();
+
+    expect(reservedProviderIds).toEqual([...MODEL_PROVIDER_IDS].sort());
+    expect(isReservedModelProviderId('custom-provider')).toBe(false);
+  });
+
   it('keeps supported catalog default models present in the pinned Pi model registry', () => {
     const supportedEntries = MODEL_PROVIDER_CATALOG_SEED.filter(
       (entry) => entry.support_status === 'supported',

package/src/core/credential-fingerprints.ts

@@ -1,6 +1,6 @@
 import type {SupportedModelProviderId} from '@shipfox/api-agent-dto';
-import {getModelProviderEntry} from '@shipfox/api-agent-dto';
 import {UnsupportedModelProviderError} from './errors.js';
+import {getModelProviderEntry} from './model-provider-policy.js';
 
 export function agentSystemNamespace(providerId: string): string {
   return `system/agent/model-provider/${providerId}`;

package/src/core/index.ts

@@ -41,6 +41,13 @@ export {
   testAndSaveModelProviderConfig,
   updateModelProviderConfigDefaultModel,
 } from './model-provider-config-service.js';
+export {
+  getModelProviderCredentialKeys,
+  getModelProviderEntry,
+  isReservedModelProviderId,
+  listSupportedModelProviders,
+  modelProviderCredentialKeysMatch,
+} from './model-provider-policy.js';
 export {
   type AgentConfigResolutionContext,
   type AgentDefaultsResolver,

package/src/core/model-provider-config-service.ts

@@ -1,8 +1,6 @@
 import {
   DEFAULT_AGENT_THINKING,
-  getModelProviderEntry,
   type ModelProviderRef,
-  modelProviderCredentialKeysMatch,
   type SupportedModelProviderId,
 } from '@shipfox/api-agent-dto';
 import {reportError} from '@shipfox/node-error-monitoring';
@@ -22,6 +20,7 @@ import {
   UnsupportedModelProviderError,
 } from './errors.js';
 import {buildModelProviderCatalog} from './model-provider-catalog.js';
+import {getModelProviderEntry, modelProviderCredentialKeysMatch} from './model-provider-policy.js';
 import {probeModelProviderCredentials, runProviderProbe} from './model-provider-validation.js';
 import {type AgentSecretsClient, requireAgentSecretsClient} from './secrets-client.js';
 

package/src/core/model-provider-policy.ts

@@ -0,0 +1,35 @@
+import type {ModelProviderCatalogSeedDto, SupportedModelProviderId} from '@shipfox/api-agent-dto';
+import {MODEL_PROVIDER_CATALOG_SEED, MODEL_PROVIDER_IDS} from '@shipfox/api-agent-dto';
+
+export function getModelProviderEntry(id: string): ModelProviderCatalogSeedDto | undefined {
+  return MODEL_PROVIDER_CATALOG_SEED.find((entry) => entry.id === id);
+}
+
+export function getModelProviderCredentialKeys(
+  providerId: SupportedModelProviderId,
+): string[] | undefined {
+  const entry = getModelProviderEntry(providerId);
+  if (entry === undefined || entry.support_status !== 'supported') return undefined;
+  return entry.credential_fields.map((field) => field.key).sort();
+}
+
+export function modelProviderCredentialKeysMatch(
+  providerId: SupportedModelProviderId,
+  credentials: Record<string, string>,
+): boolean {
+  const expectedKeys = getModelProviderCredentialKeys(providerId);
+  if (expectedKeys === undefined) return false;
+  const actualKeys = Object.keys(credentials).sort();
+  return (
+    actualKeys.length === expectedKeys.length &&
+    actualKeys.every((key, index) => key === expectedKeys[index])
+  );
+}
+
+export function listSupportedModelProviders(): readonly ModelProviderCatalogSeedDto[] {
+  return MODEL_PROVIDER_CATALOG_SEED.filter((entry) => entry.support_status === 'supported');
+}
+
+export function isReservedModelProviderId(value: string): boolean {
+  return (MODEL_PROVIDER_IDS as readonly string[]).includes(value);
+}

package/src/core/model-provider-validation.ts

@@ -5,12 +5,11 @@ import {
   getModels,
   type ProviderStreamOptions,
 } from '@earendil-works/pi-ai';
-import {
-  type CustomAgentModelDto,
-  getModelProviderEntry,
-  type ModelProviderApi,
-  type ModelProviderRef,
-  type SupportedModelProviderId,
+import type {
+  CustomAgentModelDto,
+  ModelProviderApi,
+  ModelProviderRef,
+  SupportedModelProviderId,
 } from '@shipfox/api-agent-dto';
 import {type EgressPolicy, parseEgressHostDenylist} from '@shipfox/node-egress-guard';
 import {redactSecrets, secretWireForms} from '@shipfox/redact';
@@ -24,6 +23,7 @@ import {
   ModelProviderValidationUnavailableError,
   UnsupportedModelProviderError,
 } from './errors.js';
+import {getModelProviderEntry} from './model-provider-policy.js';
 
 const PROBE_MAX_TOKENS = 64;
 const MAX_SANITIZED_ERROR_LENGTH = 500;

package/src/core/resolve-agent-config.ts

@@ -4,7 +4,6 @@ import {
   type CustomAgentModelDto,
   DEFAULT_HARNESS,
   getHarnessDescriptor,
-  getModelProviderEntry,
   type Harness,
   type ModelProviderRef,
   type SupportedModelProviderId,
@@ -16,6 +15,7 @@ import {
   UnsupportedModelProviderError,
 } from './errors.js';
 import {listHarnessProviderModels} from './harness/index.js';
+import {getModelProviderEntry} from './model-provider-policy.js';
 
 export interface ContextualAgentConfig {
   readonly harness?: Harness | undefined;

package/src/core/resolve-runtime-credentials.ts

@@ -1,11 +1,9 @@
-import {
-  type AgentRuntimeCredentialsResponseDto,
-  type AgentThinking,
-  getModelProviderEntry,
-  type Harness,
-  type ModelProviderRef,
-  modelProviderCredentialKeysMatch,
-  type SupportedModelProviderId,
+import type {
+  AgentRuntimeCredentialsResponseDto,
+  AgentThinking,
+  Harness,
+  ModelProviderRef,
+  SupportedModelProviderId,
 } from '@shipfox/api-agent-dto';
 import {secretsInterModuleContract} from '@shipfox/api-secrets-dto/inter-module';
 import {isInterModuleKnownError} from '@shipfox/inter-module';
@@ -19,6 +17,7 @@ import {
 } from './credential-fingerprints.js';
 import type {ModelProviderConfig} from './entities/model-provider-config.js';
 import {ModelProviderConfigNotFoundError} from './errors.js';
+import {getModelProviderEntry, modelProviderCredentialKeysMatch} from './model-provider-policy.js';
 import {type AgentSecretsClient, requireAgentSecretsClient} from './secrets-client.js';
 
 export interface ResolveRuntimeCredentialsParams {

package/src/core/validation-catalog.ts

@@ -1,11 +1,11 @@
 import {
-  getModelProviderEntry,
   listEnabledHarnessTools,
   listHarnessDescriptors,
   MODEL_PROVIDER_IDS,
 } from '@shipfox/api-agent-dto';
 import type {AgentValidationCatalog} from '@shipfox/api-agent-dto/inter-module';
 import {harnessToolDeploymentConfig} from '#config.js';
+import {getModelProviderEntry} from './model-provider-policy.js';
 
 /** Produces the versioned, JSON-safe policy snapshot consumed by Definitions. */
 export function getAgentValidationCatalog(): AgentValidationCatalog {

package/src/db/schema/model-provider-configs.ts

@@ -12,15 +12,15 @@ import {
   check,
   jsonb,
   pgEnum,
-  pgTable,
   text,
   timestamp,
   uniqueIndex,
   uuid,
 } from 'drizzle-orm/pg-core';
 import type {ModelProviderConfig} from '#core/entities/model-provider-config.js';
+import {pgTable} from './common.js';
 
-export const modelProviderConfigKindEnum = pgEnum('model_provider_config_kind', [
+export const modelProviderConfigKindEnum = pgEnum('agent_model_provider_config_kind', [
   'builtin',
   'custom',
 ]);
@@ -45,12 +45,12 @@ export const modelProviderConfigs = pgTable(
     updatedAt: timestamp('updated_at', {withTimezone: true}).notNull().defaultNow(),
   },
   (table) => [
-    uniqueIndex('model_provider_configs_workspace_provider_unique').on(
+    uniqueIndex('agent_model_provider_configs_workspace_provider_unique').on(
       table.workspaceId,
       table.providerId,
     ),
     check(
-      'model_provider_configs_custom_required_fields',
+      'agent_model_provider_configs_custom_required_fields',
       sql`${table.kind} <> 'custom' OR (${table.api} IS NOT NULL AND ${table.baseUrl} IS NOT NULL AND ${table.models} IS NOT NULL AND ${table.displayName} IS NOT NULL)`,
     ),
   ],

package/src/index.ts

@@ -15,12 +15,17 @@ export {
   createCustomModelProviderConfig,
   createWorkspaceAgentDefaultsResolver,
   deleteModelProviderConfig,
+  getModelProviderCredentialKeys,
+  getModelProviderEntry,
   InvalidAgentModelError,
   InvalidCredentialFieldsError,
+  isReservedModelProviderId,
+  listSupportedModelProviders,
   type ModelProviderConfig,
   ModelProviderConfigNotFoundError,
   ModelProviderValidationError,
   ModelProviderValidationUnavailableError,
+  modelProviderCredentialKeysMatch,
   type ResolvedAgentConfig,
   type ResolveRuntimeCredentialsParams,
   resolveAgentConfig,
@@ -40,7 +45,7 @@ export {
 export function createAgentModule(params: {secrets: AgentSecretsClient}): ShipfoxModule {
   return {
     name: 'agent',
-    database: {db, migrationsPath},
+    database: {db, migrationsPath, databaseNamespace: 'agent'},
     routes: createAgentRoutes(params.secrets),
     e2eRoutes: [createAgentE2eRoutes(params.secrets)],
     interModulePresentations: [createAgentInterModulePresentation(params)],

package/src/presentation/e2eRoutes/create-model-provider.ts

@@ -1,8 +1,9 @@
-import {DEFAULT_AGENT_THINKING, getModelProviderEntry} from '@shipfox/api-agent-dto';
+import {DEFAULT_AGENT_THINKING} from '@shipfox/api-agent-dto';
 import {ClientError, defineRoute} from '@shipfox/node-fastify';
 import {z} from 'zod';
 import {agentSystemNamespace} from '#core/credential-fingerprints.js';
 import {listHarnessProviderModels} from '#core/harness/registry.js';
+import {getModelProviderEntry} from '#core/model-provider-policy.js';
 import type {AgentSecretsClient} from '#core/secrets-client.js';
 import {upsertModelProviderConfig} from '#db/index.js';
 

package/src/presentation/routes/errors.ts

@@ -1,4 +1,3 @@
-import {getModelProviderCredentialKeys} from '@shipfox/api-agent-dto';
 import {secretsInterModuleContract} from '@shipfox/api-secrets-dto/inter-module';
 import {isInterModuleKnownError} from '@shipfox/inter-module';
 import {EgressDeniedError} from '@shipfox/node-egress-guard';
@@ -14,6 +13,7 @@ import {
   ModelProviderValidationError,
   UnsupportedModelProviderError,
 } from '#core/index.js';
+import {getModelProviderCredentialKeys} from '#core/model-provider-policy.js';
 
 export function translateModelProviderRouteError(error: unknown): never {
   if (error instanceof ModelProviderValidationError) {

package/src/presentation/routes/set-default-model-provider.ts

@@ -1,5 +1,4 @@
 import {
-  getModelProviderEntry,
   setDefaultModelProviderBodySchema,
   setDefaultModelProviderResponseSchema,
 } from '@shipfox/api-agent-dto';
@@ -7,6 +6,7 @@ import {requireWorkspaceAccess} from '@shipfox/api-auth-context';
 import {defineRoute} from '@shipfox/node-fastify';
 import {z} from 'zod';
 import {UnsupportedModelProviderError} from '#core/index.js';
+import {getModelProviderEntry} from '#core/model-provider-policy.js';
 import {getModelProviderConfig, setDefaultModelProvider} from '#db/index.js';
 import {translateModelProviderRouteError} from './errors.js';
 

package/test/globalSetup.ts

@@ -8,7 +8,7 @@ export async function setup() {
   createPostgresClient();
 
   await runMigrations(db(), migrationsPath, '__drizzle_migrations_agent');
-  await db().execute(sql`TRUNCATE model_provider_configs CASCADE`);
+  await db().execute(sql`TRUNCATE agent_model_provider_configs CASCADE`);
   await db().execute(sql`TRUNCATE agent_workspace_settings CASCADE`);
 
   closeDb();