@shipfox/api-integration-core 2.0.0

package/drizzle/0000_initial.sql

@@ -0,0 +1,41 @@
+CREATE TABLE "integrations_connections" (
+	"id" uuid PRIMARY KEY DEFAULT uuidv7() NOT NULL,
+	"workspace_id" uuid NOT NULL,
+	"provider" text NOT NULL,
+	"external_account_id" text NOT NULL,
+	"slug" text NOT NULL,
+	"display_name" text NOT NULL,
+	"lifecycle_status" text DEFAULT 'active' NOT NULL,
+	"created_at" timestamp with time zone DEFAULT now() NOT NULL,
+	"updated_at" timestamp with time zone DEFAULT now() NOT NULL
+);
+--> statement-breakpoint
+CREATE TABLE "integrations_outbox" (
+	"id" uuid PRIMARY KEY DEFAULT uuidv7() NOT NULL,
+	"event_type" text NOT NULL,
+	"ordering_key" text,
+	"payload" jsonb NOT NULL,
+	"created_at" timestamp with time zone DEFAULT now() NOT NULL,
+	"dispatched_at" timestamp with time zone,
+	"dispatch_attempts" integer DEFAULT 0 NOT NULL,
+	"next_dispatch_at" timestamp with time zone DEFAULT now() NOT NULL,
+	"last_dispatch_error" jsonb,
+	"last_dispatch_failed_at" timestamp with time zone,
+	"dead_lettered_at" timestamp with time zone
+);
+--> statement-breakpoint
+CREATE TABLE "integrations_webhook_deliveries" (
+	"provider" text NOT NULL,
+	"dedup_scope" text NOT NULL,
+	"delivery_id" text NOT NULL,
+	"received_at" timestamp with time zone DEFAULT now() NOT NULL,
+	CONSTRAINT "integrations_webhook_deliveries_dedup_pk" PRIMARY KEY("provider","dedup_scope","delivery_id")
+);
+--> statement-breakpoint
+CREATE UNIQUE INDEX "integrations_connections_workspace_external_unique" ON "integrations_connections" USING btree ("workspace_id","provider","external_account_id");--> statement-breakpoint
+CREATE UNIQUE INDEX "integrations_connections_workspace_slug_unique" ON "integrations_connections" USING btree ("workspace_id","slug");--> statement-breakpoint
+CREATE INDEX "integrations_connections_workspace_id_idx" ON "integrations_connections" USING btree ("workspace_id");--> statement-breakpoint
+CREATE INDEX "integrations_outbox_pending_idx" ON "integrations_outbox" USING btree ("next_dispatch_at","created_at") WHERE "dispatched_at" IS NULL AND "dead_lettered_at" IS NULL;
+--> statement-breakpoint
+CREATE INDEX "integrations_outbox_dispatched_retention_idx" ON "integrations_outbox" USING btree ("dispatched_at","id") WHERE "dispatched_at" IS NOT NULL;--> statement-breakpoint
+CREATE INDEX "integrations_webhook_deliveries_received_at_idx" ON "integrations_webhook_deliveries" USING btree ("received_at");

package/drizzle/meta/0001_snapshot.json

@@ -0,0 +1,341 @@
+{
+  "id": "a808bfbe-960e-418d-a72a-d88ddca95096",
+  "prevId": "e3544ba8-0307-4ffd-a646-3851b89bcbfb",
+  "version": "7",
+  "dialect": "postgresql",
+  "tables": {
+    "public.integrations_connections": {
+      "name": "integrations_connections",
+      "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": {
+          "name": "provider",
+          "type": "text",
+          "primaryKey": false,
+          "notNull": true
+        },
+        "external_account_id": {
+          "name": "external_account_id",
+          "type": "text",
+          "primaryKey": false,
+          "notNull": true
+        },
+        "slug": {
+          "name": "slug",
+          "type": "text",
+          "primaryKey": false,
+          "notNull": true
+        },
+        "display_name": {
+          "name": "display_name",
+          "type": "text",
+          "primaryKey": false,
+          "notNull": true
+        },
+        "lifecycle_status": {
+          "name": "lifecycle_status",
+          "type": "text",
+          "primaryKey": false,
+          "notNull": true,
+          "default": "'active'"
+        },
+        "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": {
+        "integrations_connections_workspace_external_unique": {
+          "name": "integrations_connections_workspace_external_unique",
+          "columns": [
+            {
+              "expression": "workspace_id",
+              "isExpression": false,
+              "asc": true,
+              "nulls": "last"
+            },
+            {
+              "expression": "provider",
+              "isExpression": false,
+              "asc": true,
+              "nulls": "last"
+            },
+            {
+              "expression": "external_account_id",
+              "isExpression": false,
+              "asc": true,
+              "nulls": "last"
+            }
+          ],
+          "isUnique": true,
+          "concurrently": false,
+          "method": "btree",
+          "with": {}
+        },
+        "integrations_connections_workspace_slug_unique": {
+          "name": "integrations_connections_workspace_slug_unique",
+          "columns": [
+            {
+              "expression": "workspace_id",
+              "isExpression": false,
+              "asc": true,
+              "nulls": "last"
+            },
+            {
+              "expression": "slug",
+              "isExpression": false,
+              "asc": true,
+              "nulls": "last"
+            }
+          ],
+          "isUnique": true,
+          "concurrently": false,
+          "method": "btree",
+          "with": {}
+        },
+        "integrations_connections_workspace_id_idx": {
+          "name": "integrations_connections_workspace_id_idx",
+          "columns": [
+            {
+              "expression": "workspace_id",
+              "isExpression": false,
+              "asc": true,
+              "nulls": "last"
+            }
+          ],
+          "isUnique": false,
+          "concurrently": false,
+          "method": "btree",
+          "with": {}
+        }
+      },
+      "foreignKeys": {},
+      "compositePrimaryKeys": {},
+      "uniqueConstraints": {},
+      "policies": {},
+      "checkConstraints": {},
+      "isRLSEnabled": false
+    },
+    "public.integrations_outbox": {
+      "name": "integrations_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": {
+        "integrations_outbox_pending_idx": {
+          "name": "integrations_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": {}
+        },
+        "integrations_outbox_dispatched_retention_idx": {
+          "name": "integrations_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.integrations_webhook_deliveries": {
+      "name": "integrations_webhook_deliveries",
+      "schema": "",
+      "columns": {
+        "provider": {
+          "name": "provider",
+          "type": "text",
+          "primaryKey": false,
+          "notNull": true
+        },
+        "dedup_scope": {
+          "name": "dedup_scope",
+          "type": "text",
+          "primaryKey": false,
+          "notNull": true
+        },
+        "delivery_id": {
+          "name": "delivery_id",
+          "type": "text",
+          "primaryKey": false,
+          "notNull": true
+        },
+        "received_at": {
+          "name": "received_at",
+          "type": "timestamp with time zone",
+          "primaryKey": false,
+          "notNull": true,
+          "default": "now()"
+        }
+      },
+      "indexes": {
+        "integrations_webhook_deliveries_received_at_idx": {
+          "name": "integrations_webhook_deliveries_received_at_idx",
+          "columns": [
+            {
+              "expression": "received_at",
+              "isExpression": false,
+              "asc": true,
+              "nulls": "last"
+            }
+          ],
+          "isUnique": false,
+          "concurrently": false,
+          "method": "btree",
+          "with": {}
+        }
+      },
+      "foreignKeys": {},
+      "compositePrimaryKeys": {
+        "integrations_webhook_deliveries_dedup_pk": {
+          "name": "integrations_webhook_deliveries_dedup_pk",
+          "columns": ["provider", "dedup_scope", "delivery_id"]
+        }
+      },
+      "uniqueConstraints": {},
+      "policies": {},
+      "checkConstraints": {},
+      "isRLSEnabled": false
+    }
+  },
+  "enums": {},
+  "schemas": {},
+  "sequences": {},
+  "roles": {},
+  "policies": {},
+  "views": {},
+  "_meta": {
+    "columns": {},
+    "schemas": {},
+    "tables": {}
+  }
+}

package/drizzle/meta/_journal.json

@@ -0,0 +1,13 @@
+{
+  "version": "7",
+  "dialect": "postgresql",
+  "entries": [
+    {
+      "idx": 0,
+      "version": "7",
+      "when": 1777467600000,
+      "tag": "0000_initial",
+      "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,85 @@
+{
+  "name": "@shipfox/api-integration-core",
+  "license": "MIT",
+  "version": "2.0.0",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/ShipfoxHQ/shipfox.git",
+    "directory": "libs/api/integration/core"
+  },
+  "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"
+      }
+    }
+  },
+  "dependencies": {
+    "@modelcontextprotocol/sdk": "1.29.0",
+    "@temporalio/workflow": "^1.16.1",
+    "ajv": "^8.20.0",
+    "drizzle-orm": "^0.45.2",
+    "zod": "^4.4.3",
+    "@shipfox/api-agent-dto": "2.0.0",
+    "@shipfox/api-integration-core-dto": "2.0.0",
+    "@shipfox/api-auth-context": "2.0.0",
+    "@shipfox/api-integration-sentry": "2.0.0",
+    "@shipfox/api-integration-gitea": "2.0.0",
+    "@shipfox/config": "1.2.1",
+    "@shipfox/node-drizzle": "0.2.1",
+    "@shipfox/node-module": "0.2.0",
+    "@shipfox/node-outbox": "0.2.1",
+    "@shipfox/node-temporal": "0.2.0",
+    "@shipfox/node-postgres": "0.4.1",
+    "@shipfox/node-fastify": "0.2.1",
+    "@shipfox/node-opentelemetry": "0.5.0",
+    "@shipfox/regex": "0.2.1",
+    "@shipfox/api-integration-github": "2.0.0",
+    "@shipfox/api-integration-linear": "2.0.0",
+    "@shipfox/api-integration-webhook": "2.0.0",
+    "@shipfox/redact": "0.2.1"
+  },
+  "devDependencies": {
+    "@temporalio/activity": "^1.16.1",
+    "@temporalio/client": "^1.16.1",
+    "@temporalio/common": "^1.16.1",
+    "@temporalio/testing": "^1.16.1",
+    "@temporalio/worker": "^1.16.1",
+    "@types/pg": "^8.15.5",
+    "drizzle-kit": "^0.31.10",
+    "fastify": "^5.3.3",
+    "fastify-type-provider-zod": "^6.0.0",
+    "fishery": "^2.2.2",
+    "@shipfox/biome": "1.8.1",
+    "@shipfox/ts-config": "1.3.8",
+    "@shipfox/typescript": "1.1.6",
+    "@shipfox/swc": "1.2.5",
+    "@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,32 @@
+describe('integration provider config', () => {
+  afterEach(() => {
+    vi.unstubAllEnvs();
+    vi.resetModules();
+  });
+
+  it('enables built-in providers by default', async () => {
+    vi.resetModules();
+
+    const {config} = await import('#config.js');
+
+    expect(config.INTEGRATIONS_ENABLE_CRON_PROVIDER).toBe(true);
+    expect(config.INTEGRATIONS_ENABLE_WEBHOOK_PROVIDER).toBe(true);
+  });
+
+  it('disables the Linear provider by default', async () => {
+    vi.resetModules();
+
+    const {config} = await import('#config.js');
+
+    expect(config.INTEGRATIONS_ENABLE_LINEAR_PROVIDER).toBe(false);
+  });
+
+  it('allows disabling the built-in cron provider', async () => {
+    vi.stubEnv('INTEGRATIONS_ENABLE_CRON_PROVIDER', 'false');
+    vi.resetModules();
+
+    const {config} = await import('#config.js');
+
+    expect(config.INTEGRATIONS_ENABLE_CRON_PROVIDER).toBe(false);
+  });
+});

package/src/config.ts

@@ -0,0 +1,28 @@
+import {bool, createConfig} from '@shipfox/config';
+
+export const config = createConfig({
+  INTEGRATIONS_ENABLE_CRON_PROVIDER: bool({
+    desc: 'Enables the cron integration provider so workflow schedules can use the built-in cron source. It is enabled by default because it does not require provider setup.',
+    default: true,
+  }),
+  INTEGRATIONS_ENABLE_GITEA_PROVIDER: bool({
+    desc: 'Enables the Gitea integration provider so users can connect a Gitea instance.',
+    default: false,
+  }),
+  INTEGRATIONS_ENABLE_GITHUB_PROVIDER: bool({
+    desc: 'Enables the GitHub integration provider so users can connect GitHub.',
+    default: false,
+  }),
+  INTEGRATIONS_ENABLE_LINEAR_PROVIDER: bool({
+    desc: 'Enables the Linear integration provider so users can connect Linear workspaces.',
+    default: false,
+  }),
+  INTEGRATIONS_ENABLE_SENTRY_PROVIDER: bool({
+    desc: 'Enables the Sentry integration provider so users can connect Sentry.',
+    default: false,
+  }),
+  INTEGRATIONS_ENABLE_WEBHOOK_PROVIDER: bool({
+    desc: 'Enables the generic webhook integration provider so users can create inbound webhook URLs. It is enabled by default because it does not require provider setup.',
+    default: true,
+  }),
+});

package/src/core/agent-tool-selection.test.ts

@@ -0,0 +1,137 @@
+import {integrationConnectionFactory} from '#test/factories/connection.js';
+import {
+  buildAgentToolSelectionCatalogs,
+  createWorkspaceConnectionSnapshotLoader,
+} from './agent-tool-selection.js';
+import {createIntegrationProviderRegistry} from './providers/registry.js';
+
+describe('buildAgentToolSelectionCatalogs', () => {
+  it('builds a catalog map from registered agent tool adapters', async () => {
+    const selectionCatalog = {
+      selectors: [
+        {
+          token: 'issue_read',
+          kind: 'family' as const,
+          sensitivity: 'read' as const,
+          sensitive: false,
+        },
+      ],
+    };
+    const registry = createIntegrationProviderRegistry([
+      {
+        provider: 'github',
+        displayName: 'GitHub',
+        adapters: {
+          agent_tools: {
+            catalog: () => [],
+            selectionCatalog: () => selectionCatalog,
+            openSession: async () => {
+              await Promise.resolve();
+              return {
+                call: async () => {
+                  await Promise.resolve();
+                  return {};
+                },
+              };
+            },
+          },
+        },
+      },
+    ]);
+
+    const result = await buildAgentToolSelectionCatalogs(registry);
+
+    expect(result.get('github')).toBe(selectionCatalog);
+  });
+});
+
+describe('createWorkspaceConnectionSnapshotLoader', () => {
+  it('returns workspace-scoped connection capability snapshots', async () => {
+    const workspaceId = crypto.randomUUID();
+    const otherWorkspaceId = crypto.randomUUID();
+    const registry = createIntegrationProviderRegistry([
+      sourceProvider('gitea'),
+      agentToolsProvider('github'),
+    ]);
+    const loader = createWorkspaceConnectionSnapshotLoader(registry);
+    const giteaConnection = await integrationConnectionFactory.create({
+      workspaceId,
+      provider: 'gitea',
+      slug: 'gitea_main',
+    });
+    const githubConnection = await integrationConnectionFactory.create({
+      workspaceId,
+      provider: 'github',
+      slug: 'github_main',
+    });
+    await integrationConnectionFactory.create({
+      workspaceId: otherWorkspaceId,
+      provider: 'github',
+      slug: 'other_github',
+    });
+
+    const snapshot = await loader(workspaceId);
+
+    expect(snapshot).toEqual(
+      new Map([
+        [
+          'gitea_main',
+          {id: giteaConnection.id, provider: 'gitea', capabilities: ['source_control']},
+        ],
+        [
+          'github_main',
+          {id: githubConnection.id, provider: 'github', capabilities: ['agent_tools']},
+        ],
+      ]),
+    );
+  });
+});
+
+function sourceProvider(provider: string) {
+  return {
+    provider,
+    displayName: provider,
+    adapters: {
+      source_control: {
+        listRepositories: async () => {
+          await Promise.resolve();
+          return {repositories: [], nextCursor: null};
+        },
+        resolveRepository: async () => {
+          await Promise.resolve();
+          throw new Error('not used');
+        },
+        listFiles: async () => {
+          await Promise.resolve();
+          return {files: [], nextCursor: null};
+        },
+        fetchFile: async () => {
+          await Promise.resolve();
+          throw new Error('not used');
+        },
+      },
+    },
+  };
+}
+
+function agentToolsProvider(provider: string) {
+  return {
+    provider,
+    displayName: provider,
+    adapters: {
+      agent_tools: {
+        catalog: () => [],
+        selectionCatalog: () => ({selectors: []}),
+        openSession: async () => {
+          await Promise.resolve();
+          return {
+            call: async () => {
+              await Promise.resolve();
+              return {};
+            },
+          };
+        },
+      },
+    },
+  };
+}