@shipfox/api-agent 2.0.0

package/drizzle/0000_daffy_leopardon.sql

@@ -0,0 +1,28 @@
+CREATE TYPE "public"."model_provider_config_kind" AS ENUM('builtin', 'custom');--> statement-breakpoint
+CREATE TABLE "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,
+	"display_name" text,
+	"api" text,
+	"base_url" text,
+	"headers" jsonb,
+	"secret_header_names" jsonb,
+	"models" jsonb,
+	"requires_api_key" boolean DEFAULT false NOT NULL,
+	"default_model" text,
+	"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))
+);
+--> statement-breakpoint
+CREATE TABLE "agent_workspace_settings" (
+	"workspace_id" uuid PRIMARY KEY NOT NULL,
+	"default_provider_id" text,
+	"created_at" timestamp with time zone DEFAULT now() NOT NULL,
+	"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");

package/drizzle/0001_default_harness.sql

@@ -0,0 +1 @@
+ALTER TABLE "agent_workspace_settings" ADD COLUMN "default_harness_id" text;

package/drizzle/meta/0000_snapshot.json

@@ -0,0 +1,199 @@
+{
+  "id": "9e6949f6-d9ef-4c8a-8b22-42ffd11a7e59",
+  "prevId": "00000000-0000-0000-0000-000000000000",
+  "version": "7",
+  "dialect": "postgresql",
+  "tables": {
+    "public.model_provider_configs": {
+      "name": "model_provider_configs",
+      "schema": "",
+      "columns": {
+        "id": {
+          "name": "id",
+          "type": "uuid",
+          "primaryKey": true,
+          "notNull": true,
+          "default": "uuidv7()"
+        },
+        "workspace_id": {
+          "name": "workspace_id",
+          "type": "uuid",
+          "primaryKey": false,
+          "notNull": true
+        },
+        "provider_id": {
+          "name": "provider_id",
+          "type": "text",
+          "primaryKey": false,
+          "notNull": true
+        },
+        "kind": {
+          "name": "kind",
+          "type": "model_provider_config_kind",
+          "primaryKey": false,
+          "notNull": true,
+          "default": "'builtin'"
+        },
+        "display_name": {
+          "name": "display_name",
+          "type": "text",
+          "primaryKey": false,
+          "notNull": false
+        },
+        "api": {
+          "name": "api",
+          "type": "text",
+          "primaryKey": false,
+          "notNull": false
+        },
+        "base_url": {
+          "name": "base_url",
+          "type": "text",
+          "primaryKey": false,
+          "notNull": false
+        },
+        "headers": {
+          "name": "headers",
+          "type": "jsonb",
+          "primaryKey": false,
+          "notNull": false
+        },
+        "secret_header_names": {
+          "name": "secret_header_names",
+          "type": "jsonb",
+          "primaryKey": false,
+          "notNull": false
+        },
+        "models": {
+          "name": "models",
+          "type": "jsonb",
+          "primaryKey": false,
+          "notNull": false
+        },
+        "requires_api_key": {
+          "name": "requires_api_key",
+          "type": "boolean",
+          "primaryKey": false,
+          "notNull": true,
+          "default": "false"
+        },
+        "default_model": {
+          "name": "default_model",
+          "type": "text",
+          "primaryKey": false,
+          "notNull": false
+        },
+        "default_thinking": {
+          "name": "default_thinking",
+          "type": "text",
+          "primaryKey": false,
+          "notNull": true
+        },
+        "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": {
+        "model_provider_configs_workspace_provider_unique": {
+          "name": "model_provider_configs_workspace_provider_unique",
+          "columns": [
+            {
+              "expression": "workspace_id",
+              "isExpression": false,
+              "asc": true,
+              "nulls": "last"
+            },
+            {
+              "expression": "provider_id",
+              "isExpression": false,
+              "asc": true,
+              "nulls": "last"
+            }
+          ],
+          "isUnique": true,
+          "concurrently": false,
+          "method": "btree",
+          "with": {}
+        }
+      },
+      "foreignKeys": {},
+      "compositePrimaryKeys": {},
+      "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)"
+        }
+      },
+      "isRLSEnabled": false
+    },
+    "public.agent_workspace_settings": {
+      "name": "agent_workspace_settings",
+      "schema": "",
+      "columns": {
+        "workspace_id": {
+          "name": "workspace_id",
+          "type": "uuid",
+          "primaryKey": true,
+          "notNull": true
+        },
+        "default_provider_id": {
+          "name": "default_provider_id",
+          "type": "text",
+          "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": {},
+      "foreignKeys": {},
+      "compositePrimaryKeys": {},
+      "uniqueConstraints": {},
+      "policies": {},
+      "checkConstraints": {},
+      "isRLSEnabled": false
+    }
+  },
+  "enums": {
+    "public.model_provider_config_kind": {
+      "name": "model_provider_config_kind",
+      "schema": "public",
+      "values": ["builtin", "custom"]
+    }
+  },
+  "schemas": {},
+  "sequences": {},
+  "roles": {},
+  "policies": {},
+  "views": {},
+  "_meta": {
+    "columns": {},
+    "schemas": {},
+    "tables": {}
+  }
+}

package/drizzle/meta/0001_snapshot.json

@@ -0,0 +1,205 @@
+{
+  "id": "dbe0db16-5b0d-4aa0-8a5d-48fe27753e88",
+  "prevId": "9e6949f6-d9ef-4c8a-8b22-42ffd11a7e59",
+  "version": "7",
+  "dialect": "postgresql",
+  "tables": {
+    "public.model_provider_configs": {
+      "name": "model_provider_configs",
+      "schema": "",
+      "columns": {
+        "id": {
+          "name": "id",
+          "type": "uuid",
+          "primaryKey": true,
+          "notNull": true,
+          "default": "uuidv7()"
+        },
+        "workspace_id": {
+          "name": "workspace_id",
+          "type": "uuid",
+          "primaryKey": false,
+          "notNull": true
+        },
+        "provider_id": {
+          "name": "provider_id",
+          "type": "text",
+          "primaryKey": false,
+          "notNull": true
+        },
+        "kind": {
+          "name": "kind",
+          "type": "model_provider_config_kind",
+          "primaryKey": false,
+          "notNull": true,
+          "default": "'builtin'"
+        },
+        "display_name": {
+          "name": "display_name",
+          "type": "text",
+          "primaryKey": false,
+          "notNull": false
+        },
+        "api": {
+          "name": "api",
+          "type": "text",
+          "primaryKey": false,
+          "notNull": false
+        },
+        "base_url": {
+          "name": "base_url",
+          "type": "text",
+          "primaryKey": false,
+          "notNull": false
+        },
+        "headers": {
+          "name": "headers",
+          "type": "jsonb",
+          "primaryKey": false,
+          "notNull": false
+        },
+        "secret_header_names": {
+          "name": "secret_header_names",
+          "type": "jsonb",
+          "primaryKey": false,
+          "notNull": false
+        },
+        "models": {
+          "name": "models",
+          "type": "jsonb",
+          "primaryKey": false,
+          "notNull": false
+        },
+        "requires_api_key": {
+          "name": "requires_api_key",
+          "type": "boolean",
+          "primaryKey": false,
+          "notNull": true,
+          "default": "false"
+        },
+        "default_model": {
+          "name": "default_model",
+          "type": "text",
+          "primaryKey": false,
+          "notNull": false
+        },
+        "default_thinking": {
+          "name": "default_thinking",
+          "type": "text",
+          "primaryKey": false,
+          "notNull": true
+        },
+        "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": {
+        "model_provider_configs_workspace_provider_unique": {
+          "name": "model_provider_configs_workspace_provider_unique",
+          "columns": [
+            {
+              "expression": "workspace_id",
+              "isExpression": false,
+              "asc": true,
+              "nulls": "last"
+            },
+            {
+              "expression": "provider_id",
+              "isExpression": false,
+              "asc": true,
+              "nulls": "last"
+            }
+          ],
+          "isUnique": true,
+          "concurrently": false,
+          "method": "btree",
+          "with": {}
+        }
+      },
+      "foreignKeys": {},
+      "compositePrimaryKeys": {},
+      "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)"
+        }
+      },
+      "isRLSEnabled": false
+    },
+    "public.agent_workspace_settings": {
+      "name": "agent_workspace_settings",
+      "schema": "",
+      "columns": {
+        "workspace_id": {
+          "name": "workspace_id",
+          "type": "uuid",
+          "primaryKey": true,
+          "notNull": true
+        },
+        "default_provider_id": {
+          "name": "default_provider_id",
+          "type": "text",
+          "primaryKey": false,
+          "notNull": false
+        },
+        "default_harness_id": {
+          "name": "default_harness_id",
+          "type": "text",
+          "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": {},
+      "foreignKeys": {},
+      "compositePrimaryKeys": {},
+      "uniqueConstraints": {},
+      "policies": {},
+      "checkConstraints": {},
+      "isRLSEnabled": false
+    }
+  },
+  "enums": {
+    "public.model_provider_config_kind": {
+      "name": "model_provider_config_kind",
+      "schema": "public",
+      "values": ["builtin", "custom"]
+    }
+  },
+  "schemas": {},
+  "sequences": {},
+  "roles": {},
+  "policies": {},
+  "views": {},
+  "_meta": {
+    "columns": {},
+    "schemas": {},
+    "tables": {}
+  }
+}

package/drizzle/meta/_journal.json

@@ -0,0 +1,20 @@
+{
+  "version": "7",
+  "dialect": "postgresql",
+  "entries": [
+    {
+      "idx": 0,
+      "version": "7",
+      "when": 1782630453879,
+      "tag": "0000_daffy_leopardon",
+      "breakpoints": true
+    },
+    {
+      "idx": 1,
+      "version": "7",
+      "when": 1783264300000,
+      "tag": "0001_default_harness",
+      "breakpoints": true
+    }
+  ]
+}

package/drizzle.config.ts

@@ -0,0 +1,7 @@
+import {defineConfig} from 'drizzle-kit';
+
+export default defineConfig({
+  schema: './src/db/schema/*.ts',
+  out: './drizzle',
+  dialect: 'postgresql',
+});

package/package.json

@@ -0,0 +1,109 @@
+{
+  "name": "@shipfox/api-agent",
+  "license": "MIT",
+  "version": "2.0.0",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/ShipfoxHQ/shipfox.git",
+    "directory": "libs/api/agent"
+  },
+  "private": false,
+  "type": "module",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "imports": {
+    "#test/*": "./test/*",
+    "#*": {
+      "workspace-source": "./src/*",
+      "development": "./src/*",
+      "default": "./dist/*"
+    }
+  },
+  "exports": {
+    ".": {
+      "development": {
+        "types": "./src/index.ts",
+        "default": "./src/index.ts"
+      },
+      "default": {
+        "types": "./dist/index.d.ts",
+        "default": "./dist/index.js"
+      }
+    },
+    "./core/errors": {
+      "development": {
+        "types": "./src/core/errors.ts",
+        "default": "./src/core/errors.ts"
+      },
+      "default": {
+        "types": "./dist/core/errors.d.ts",
+        "default": "./dist/core/errors.js"
+      }
+    },
+    "./core/resolve-agent-config": {
+      "development": {
+        "types": "./src/core/resolve-agent-config.ts",
+        "default": "./src/core/resolve-agent-config.ts"
+      },
+      "default": {
+        "types": "./dist/core/resolve-agent-config.d.ts",
+        "default": "./dist/core/resolve-agent-config.js"
+      }
+    },
+    "./core/resolve-runtime-credentials": {
+      "development": {
+        "types": "./src/core/resolve-runtime-credentials.ts",
+        "default": "./src/core/resolve-runtime-credentials.ts"
+      },
+      "default": {
+        "types": "./dist/core/resolve-runtime-credentials.d.ts",
+        "default": "./dist/core/resolve-runtime-credentials.js"
+      }
+    },
+    "./core/workspace-agent-defaults-resolver": {
+      "development": {
+        "types": "./src/core/workspace-agent-defaults-resolver.ts",
+        "default": "./src/core/workspace-agent-defaults-resolver.ts"
+      },
+      "default": {
+        "types": "./dist/core/workspace-agent-defaults-resolver.d.ts",
+        "default": "./dist/core/workspace-agent-defaults-resolver.js"
+      }
+    }
+  },
+  "dependencies": {
+    "@earendil-works/pi-ai": "0.79.9",
+    "@opentelemetry/api": "1.9.1",
+    "drizzle-orm": "^0.45.2",
+    "zod": "^4.4.3",
+    "@shipfox/api-agent-dto": "2.0.0",
+    "@shipfox/api-secrets": "2.0.0",
+    "@shipfox/api-auth-context": "2.0.0",
+    "@shipfox/node-drizzle": "0.2.1",
+    "@shipfox/config": "1.2.1",
+    "@shipfox/node-egress-guard": "0.1.0",
+    "@shipfox/node-module": "0.2.0",
+    "@shipfox/node-opentelemetry": "0.5.0",
+    "@shipfox/node-fastify": "0.2.1",
+    "@shipfox/node-postgres": "0.4.1",
+    "@shipfox/redact": "0.2.1"
+  },
+  "devDependencies": {
+    "@types/pg": "^8.15.5",
+    "drizzle-kit": "^0.31.10",
+    "@shipfox/ts-config": "1.3.8",
+    "@shipfox/swc": "1.2.5",
+    "@shipfox/typescript": "1.1.6",
+    "@shipfox/biome": "1.8.1",
+    "@shipfox/vitest": "1.2.2"
+  },
+  "scripts": {
+    "build": "shipfox-swc",
+    "check": "shipfox-biome-check",
+    "check:fix": "shipfox-biome-check --write",
+    "test": "shipfox-vitest-run",
+    "test:watch": "shipfox-vitest-watch",
+    "type": "shipfox-tsc-check",
+    "type:emit": "shipfox-tsc-emit"
+  }
+}

package/src/config.test.ts

@@ -0,0 +1,118 @@
+describe('agent config', () => {
+  afterEach(() => {
+    vi.unstubAllEnvs();
+  });
+
+  it('imports with an API-key-only instance default provider key', async () => {
+    vi.resetModules();
+    vi.stubEnv('AGENT_DEFAULT_PROVIDER', 'openai');
+    vi.stubEnv('AGENT_DEFAULT_PROVIDER_API_KEY', 'sk-instance-secret');
+
+    const module = await import('./config.js');
+
+    expect(module.config.AGENT_DEFAULT_PROVIDER).toBe('openai');
+    expect(module.config.AGENT_DEFAULT_PROVIDER_API_KEY).toBe('sk-instance-secret');
+  });
+
+  it('throws when an instance key is set for a multi-field provider', async () => {
+    vi.resetModules();
+    vi.stubEnv('AGENT_DEFAULT_PROVIDER', 'azure-openai-responses');
+    vi.stubEnv('AGENT_DEFAULT_PROVIDER_API_KEY', 'sk-instance-secret');
+
+    const importConfig = import('./config.js');
+
+    await expect(importConfig).rejects.toThrow(
+      'AGENT_DEFAULT_PROVIDER_API_KEY requires AGENT_DEFAULT_PROVIDER',
+    );
+  });
+
+  it('throws when an instance key is set without an instance default provider', async () => {
+    vi.resetModules();
+    vi.stubEnv('AGENT_DEFAULT_PROVIDER_API_KEY', 'sk-instance-secret');
+
+    const importConfig = import('./config.js');
+
+    await expect(importConfig).rejects.toThrow(
+      'AGENT_DEFAULT_PROVIDER_API_KEY requires AGENT_DEFAULT_PROVIDER',
+    );
+  });
+
+  it('imports without an instance key', async () => {
+    vi.resetModules();
+    vi.stubEnv('AGENT_DEFAULT_PROVIDER', 'azure-openai-responses');
+
+    const module = await import('./config.js');
+
+    expect(module.config.AGENT_DEFAULT_PROVIDER).toBe('azure-openai-responses');
+    expect(module.config.AGENT_DEFAULT_PROVIDER_API_KEY).toBeUndefined();
+  });
+
+  it('defaults custom provider egress to local-development friendly settings', async () => {
+    vi.resetModules();
+
+    const module = await import('./config.js');
+
+    expect(module.config.AGENT_CUSTOM_PROVIDER_ALLOW_PRIVATE_NETWORKS).toBe(true);
+    expect(module.config.AGENT_CUSTOM_PROVIDER_HOST_DENYLIST).toBe('');
+  });
+
+  it('imports custom provider egress cloud overrides', async () => {
+    vi.resetModules();
+    vi.stubEnv('AGENT_CUSTOM_PROVIDER_ALLOW_PRIVATE_NETWORKS', 'false');
+    vi.stubEnv('AGENT_CUSTOM_PROVIDER_HOST_DENYLIST', 'metadata.google.internal,10.0.0.0/8');
+
+    const module = await import('./config.js');
+
+    expect(module.config.AGENT_CUSTOM_PROVIDER_ALLOW_PRIVATE_NETWORKS).toBe(false);
+    expect(module.config.AGENT_CUSTOM_PROVIDER_HOST_DENYLIST).toBe(
+      'metadata.google.internal,10.0.0.0/8',
+    );
+  });
+
+  it('defaults pi web access to enabled', async () => {
+    vi.resetModules();
+
+    const module = await import('./config.js');
+
+    expect(module.config.AGENT_PI_ENABLED_TOOL_PACKAGES).toBe('pi-web-access');
+    expect(module.config.AGENT_PI_WEB_SEARCH_ENABLED).toBe(true);
+    expect(module.harnessToolDeploymentConfig).toEqual({
+      pi: {enabledToolPackages: ['pi-web-access'], webSearchEnabled: true},
+      claude: {enabledToolPackages: []},
+    });
+  });
+
+  it('allows deployments to disable pi optional tool packages', async () => {
+    vi.resetModules();
+    vi.stubEnv('AGENT_PI_ENABLED_TOOL_PACKAGES', '');
+
+    const module = await import('./config.js');
+
+    expect(module.harnessToolDeploymentConfig).toEqual({
+      pi: {enabledToolPackages: [], webSearchEnabled: true},
+      claude: {enabledToolPackages: []},
+    });
+  });
+
+  it('parses enabled pi optional tool packages and web search overrides', async () => {
+    vi.resetModules();
+    vi.stubEnv('AGENT_PI_ENABLED_TOOL_PACKAGES', 'pi-web-access, pi-web-access');
+    vi.stubEnv('AGENT_PI_WEB_SEARCH_ENABLED', 'false');
+
+    const module = await import('./config.js');
+
+    expect(module.harnessToolDeploymentConfig).toEqual({
+      pi: {enabledToolPackages: ['pi-web-access'], webSearchEnabled: false},
+      claude: {enabledToolPackages: []},
+    });
+  });
+
+  it('throws when pi optional tool packages include an unsupported package', async () => {
+    vi.resetModules();
+    vi.stubEnv('AGENT_PI_ENABLED_TOOL_PACKAGES', 'pi-web-access, unknown-package');
+
+    const importConfig = import('./config.js');
+
+    await expect(importConfig).rejects.toThrow('AGENT_PI_ENABLED_TOOL_PACKAGES');
+  });
+});