@inkeep/agents-core 0.0.0-dev-20250910233133

package/LICENSE.md

@@ -0,0 +1,56 @@
+<!--
+AUTO-GENERATED FILE - DO NOT EDIT DIRECTLY
+Source: ./LICENSE.md
+This file is automatically copied from the root LICENSE.md during build.
+Any changes should be made to the root LICENSE.md file.
+-->
+
+# Inkeep SDK – Elastic License 2.0 with Supplemental Terms
+
+NOTE: The Inkeep SDK is licensed under the Elastic License 2.0 (ELv2), subject to Supplemental Terms included in [SUPPLEMENTAL_TERMS.md](SUPPLEMENTAL_TERMS.md). In the event of conflict, the Supplemental Terms control.
+
+# Elastic License 2.0
+
+## Acceptance  
+By using the software, you agree to all of the terms and conditions below.
+
+## Copyright License
+The licensor grants you a non-exclusive, royalty-free, worldwide, non-sublicensable, non-transferable license to use, copy, distribute, make available, and prepare derivative works of the software, in each case subject to the limitations and conditions below.
+
+## Limitations
+You may not provide the software to third parties as a hosted or managed service, where the service provides users with access to any substantial set of the features or functionality of the software.
+
+You may not move, change, disable, or circumvent the license key functionality in the software, and you may not remove or obscure any functionality in the software that is protected by the license key.
+
+You may not alter, remove, or obscure any licensing, copyright, or other notices of the licensor in the software. Any use of the licensor’s trademarks is subject to applicable law.
+
+## Patents
+The licensor grants you a license, under any patent claims the licensor can license, or becomes able to license, to make, have made, use, sell, offer for sale, import and have imported the software, in each case subject to the limitations and conditions in this license. This license does not cover any patent claims that you cause to be infringed by modifications or additions to the software. If you or your company make any written claim that the software infringes or contributes to infringement of any patent, your patent license for the software granted under these terms ends immediately. If your company makes such a claim, your patent license ends immediately for work on behalf of your company.
+
+## Notices
+You must ensure that anyone who gets a copy of any part of the software from you also gets a copy of these terms.
+
+If you modify the software, you must include in any modified copies of the software prominent notices stating that you have modified the software.
+
+## No Other Rights
+These terms do not imply any licenses other than those expressly granted in these terms.
+
+## Termination
+If you use the software in violation of these terms, such use is not licensed, and your licenses will automatically terminate. If the licensor provides you with a notice of your violation, and you cease all violation of this license no later than 30 days after you receive that notice, your licenses will be reinstated retroactively. However, if you violate these terms after such reinstatement, any additional violation of these terms will cause your licenses to terminate automatically and permanently.
+
+## No Liability
+***As far as the law allows, the software comes as is, without any warranty or condition, and the licensor will not be liable to you for any damages arising out of these terms or the use or nature of the software, under any kind of legal claim.***
+
+## Definitions
+The **licensor** is the entity offering these terms, and the **software** is the software the licensor makes available under these terms, including any portion of it.
+
+**you** refers to the individual or entity agreeing to these terms.
+
+**your company** is any legal entity, sole proprietorship, or other kind of organization that you work for, plus all organizations that have control over, are under the control of, or are under common control with that organization. **control** means ownership of substantially all the assets of an entity, or the power to direct its management and policies by vote, contract, or otherwise. Control can be direct or indirect.
+
+**your licenses** are all the licenses granted to you for the software under these terms.
+
+**use** means anything you do with the software requiring one of your licenses.
+
+**trademark** means trademarks, service marks, and similar rights.
+

package/README.md

@@ -0,0 +1,464 @@
+# @inkeep/agents-core
+
+Core database schema, types, validation, and data access layer for the Inkeep Agent Framework.
+
+## Overview
+
+This package serves as the single source of truth for:
+- **Database Schema**: Drizzle ORM schema definitions
+- **Type System**: TypeScript types inferred from schemas
+- **Validation**: Zod schemas for runtime validation
+- **Data Access**: Functional data access layer with dependency injection
+- **Migrations**: Database migration management
+
+## Installation
+
+```bash
+pnpm add @inkeep/agents-core
+```
+
+## Architecture
+
+### Schema as Source of Truth
+
+The Drizzle schema (`src/db/index.ts`) is the authoritative source for all database structure. From this schema:
+1. Database tables are generated
+2. Zod validation schemas are derived
+3. TypeScript types are inferred
+4. SQL migrations are created
+
+### Functional Data Access Pattern
+
+All data access functions follow a consistent functional pattern with dependency injection:
+
+```typescript
+export const getAgentById = (db: DatabaseClient) => async (params: {
+  tenantId: string;
+  projectId: string;
+  agentId: string;
+}) => {
+  // Implementation
+};
+```
+
+This pattern enables:
+- Easy testing with mock databases
+- Flexible database configuration
+- Clean separation of concerns
+- Composable data operations
+
+## Usage
+
+### Database Client
+
+```typescript
+import { createDatabaseClient } from '@inkeep/agents-core/data-access';
+
+// Production database
+const db = createDatabaseClient({
+  url: 'file:./production.db',
+  authToken: process.env.DATABASE_AUTH_TOKEN,
+});
+
+// In-memory database for testing
+const testDb = createInMemoryDatabaseClient();
+```
+
+### Data Access
+
+```typescript
+import { getAgentById, createAgent, updateAgent } from '@inkeep/agents-core/data-access';
+
+// Create function with database dependency
+const getAgent = getAgentById(db);
+
+// Use the function
+const agent = await getAgent({
+  tenantId: 'tenant-1',
+  projectId: 'project-1',
+  agentId: 'agent-1'
+});
+```
+
+### Validation
+
+```typescript
+import { AgentInsertSchema, AgentUpdateSchema } from '@inkeep/agents-core/validation';
+
+// Validate input data
+const validatedData = AgentInsertSchema.parse({
+  id: 'agent-1',
+  tenantId: 'tenant-1',
+  projectId: 'project-1',
+  name: 'Support Agent',
+  description: 'Handles customer support',
+  instructions: 'Be helpful and professional'
+});
+
+// Partial validation for updates
+const updateData = AgentUpdateSchema.parse({
+  name: 'Updated Agent Name'
+});
+```
+
+### Types
+
+```typescript
+import type { 
+  AgentInsert, 
+  AgentSelect,
+  TaskInsert,
+  ConversationSelect 
+} from '@inkeep/agents-core/validation';
+
+// Use types in your application
+function processAgent(agent: AgentSelect) {
+  console.log(agent.name);
+}
+```
+
+## Database Migrations
+
+### Generate Migrations
+
+After modifying the schema in `src/db/index.ts`:
+
+```bash
+# Generate SQL migration files
+pnpm db:generate
+
+# Preview changes
+pnpm db:check
+```
+
+### Apply Migrations
+
+```bash
+# Push schema changes directly (development)
+pnpm db:push
+
+# Run migrations (production)
+pnpm db:migrate
+```
+
+### Database Studio
+
+```bash
+# Open Drizzle Studio for database inspection
+pnpm db:studio
+```
+
+## Testing
+
+The package includes comprehensive tests for all components:
+
+```bash
+# Run tests
+pnpm test
+
+# Run tests with coverage
+pnpm test:coverage
+
+# Watch mode
+pnpm test:watch
+```
+
+Tests use in-memory SQLite databases for isolation and speed.
+
+
+## Multi-Service Architecture
+
+This package is designed to support a multi-service architecture:
+
+### Management API
+Handles CRUD operations and entity management:
+- Creating/updating agents
+- Managing agent relationships
+- Configuring tools
+- Database migrations
+
+### Execution API
+Handles runtime operations:
+- Processing conversations
+- Executing tasks
+- Agent communication
+- Tool invocation
+
+Both services share the same database schema and data access layer from this core package.
+
+## Development
+
+```bash
+# Install dependencies
+pnpm install
+
+# Build the package
+pnpm build
+
+# Development mode (watch)
+pnpm dev
+
+# Linting and formatting
+pnpm lint
+pnpm format
+
+# Type checking
+pnpm typecheck
+```
+
+## Contributing
+
+### Adding a New Entity to the Database Schema
+
+When adding a new entity to the Inkeep Agent Framework, follow these steps to ensure proper integration across the schema, validation, and data access layers:
+
+#### Step 1: Define the Drizzle Schema
+
+Add your table definition to `src/db/index.ts`:
+
+```typescript
+// Example: Adding a "workflows" table
+export const workflows = sqliteTable(
+  'workflows',
+  {
+    id: text('id').notNull().primaryKey(),
+    tenantId: text('tenant_id').notNull(),
+    projectId: text('project_id').notNull(),
+    name: text('name').notNull(),
+    description: text('description'),
+    config: text('config', { mode: 'json' }),
+    status: text('status').notNull().default('draft'),
+    createdAt: text('created_at')
+      .notNull()
+      .default(sql`(datetime('now'))`),
+    updatedAt: text('updated_at')
+      .notNull()
+      .default(sql`(datetime('now'))`),
+  },
+  (table) => ({
+    tenantProjectIdx: index('workflows_tenant_project_idx')
+      .on(table.tenantId, table.projectId),
+  })
+);
+```
+
+#### Step 2: Add Relationships (if applicable)
+
+Define any relationships with existing tables:
+
+```typescript
+export const workflowRelations = relations(workflows, ({ one, many }) => ({
+  // Example: A workflow belongs to an agent graph
+  agentGraph: one(agentGraphs, {
+    fields: [workflows.agentGraphId],
+    references: [agentGraphs.id],
+  }),
+  // Example: A workflow can have many tasks
+  tasks: many(tasks),
+}));
+```
+
+#### Step 3: Create Validation Schemas
+
+Add validation schemas to `src/validation/schemas.ts`:
+
+```typescript
+// Select schema (for reading from database)
+export const WorkflowSelectSchema = createSelectSchema(workflows);
+
+// Insert schema (for creating new records)
+export const WorkflowInsertSchema = createInsertSchema(workflows).extend({
+  id: resourceIdSchema,
+  config: z.object({
+    // Define your config structure
+    triggers: z.array(z.string()).optional(),
+    actions: z.array(z.string()).optional(),
+  }).optional(),
+});
+
+// Update schema (for partial updates)
+export const WorkflowUpdateSchema = WorkflowInsertSchema.partial().omit({
+  id: true,
+  tenantId: true,
+  projectId: true,
+});
+
+// API schemas (without tenant/project IDs for external APIs)
+export const WorkflowApiSelectSchema = createApiSchema(WorkflowSelectSchema);
+export const WorkflowApiInsertSchema = createApiInsertSchema(WorkflowInsertSchema);
+export const WorkflowApiUpdateSchema = createApiUpdateSchema(WorkflowUpdateSchema);
+```
+
+### Step 3.5: Add Types
+
+Add types to `src/types/entities`
+
+```typescript
+export type WorkflowSelect = z.infer<typeof WorkflowSelectSchema>;
+export type WorkflowInsert = z.infer<typeof WorkflowInsertSchema>;
+export type WorkflowUpdate = z.infer<typeof WorkflowUpdateSchema>;
+export type WorkflowApiSelect = z.infer<typeof WorkflowApiSelectSchema>;
+export type WorkflowApiInsert = z.infer<typeof WorkflowApiInsertSchema>;
+export type WorkflowApiUpdate = z.infer<typeof WorkflowApiUpdateSchema>;
+```
+
+add any types not directly inferred from the drizzle schema to `src/types/utility.ts`
+
+#### Step 4: Create Data Access Functions
+
+Create a new file `src/data-access/workflows.ts`:
+
+```typescript
+import { eq, and } from 'drizzle-orm';
+import { workflows } from '../db/index';
+import type { DatabaseClient } from './client';
+
+// Get workflow by ID
+export const getWorkflowById = (db: DatabaseClient) => async (params: {
+  tenantId: string;
+  projectId: string;
+  workflowId: string;
+}) => {
+  return db.query.workflows.findFirst({
+    where: and(
+      eq(workflows.tenantId, params.tenantId),
+      eq(workflows.projectId, params.projectId),
+      eq(workflows.id, params.workflowId)
+    ),
+  });
+};
+
+// List workflows
+export const listWorkflows = (db: DatabaseClient) => async (params: {
+  tenantId: string;
+  projectId: string;
+}) => {
+  return db.query.workflows.findMany({
+    where: and(
+      eq(workflows.tenantId, params.tenantId),
+      eq(workflows.projectId, params.projectId)
+    ),
+    orderBy: (workflows, { desc }) => [desc(workflows.createdAt)],
+  });
+};
+
+// Create workflow
+export const createWorkflow = (db: DatabaseClient) => async (params: {
+  tenantId: string;
+  projectId: string;
+  data: any;
+}) => {
+  const [result] = await db.insert(workflows).values({
+    ...params.data,
+    tenantId: params.tenantId,
+    projectId: params.projectId,
+  }).returning();
+  return result;
+};
+
+// Update workflow
+export const updateWorkflow = (db: DatabaseClient) => async (params: {
+  tenantId: string;
+  projectId: string;
+  workflowId: string;
+  data: any;
+}) => {
+  const [result] = await db
+    .update(workflows)
+    .set({
+      ...params.data,
+      updatedAt: new Date().toISOString(),
+    })
+    .where(
+      and(
+        eq(workflows.tenantId, params.tenantId),
+        eq(workflows.projectId, params.projectId),
+        eq(workflows.id, params.workflowId)
+      )
+    )
+    .returning();
+  return result;
+};
+
+// Delete workflow
+export const deleteWorkflow = (db: DatabaseClient) => async (params: {
+  tenantId: string;
+  projectId: string;
+  workflowId: string;
+}) => {
+  await db.delete(workflows).where(
+    and(
+      eq(workflows.tenantId, params.tenantId),
+      eq(workflows.projectId, params.projectId),
+      eq(workflows.id, params.workflowId)
+    )
+  );
+  return true;
+};
+```
+
+#### Step 5: Export from Index Files
+
+Update the relevant index files to export your new schemas and functions:
+
+In `src/data-access/index.ts`:
+```typescript
+export * from './workflows';
+```
+
+#### Step 6: Generate and Apply Migrations
+
+```bash
+# Generate SQL migration for your new table
+pnpm db:generate
+
+# Apply migration to database
+pnpm db:push
+
+# Or for production, run migrations
+pnpm db:migrate
+```
+
+#### Step 7: Write Tests
+
+Create test files for your new entity:
+
+1. **Unit tests** in `src/__tests__/validation/workflows.test.ts`:
+   - Test schema validation
+   - Test edge cases and constraints
+
+2. **Integration tests** in `src/__tests__/integration/workflows.test.ts`:
+   - Test CRUD operations with real database
+   - Test relationships with other entities
+   - Test tenant isolation
+
+Example integration test:
+```typescript
+describe('Workflow Integration Tests', () => {
+  let db: DatabaseClient;
+  
+  beforeEach(() => {
+    db = createInMemoryDatabaseClient();
+  });
+
+  it('should create and retrieve a workflow', async () => {
+    const workflowData = {
+      id: 'test-workflow',
+      tenantId: 'test-tenant',
+      projectId: 'test-project',
+      name: 'Test Workflow',
+      description: 'A test workflow',
+      status: 'draft',
+    };
+
+    const created = await createWorkflow(db)({
+      tenantId: workflowData.tenantId,
+      projectId: workflowData.projectId,
+      data: workflowData,
+    });
+
+    expect(created.name).toBe(workflowData.name);
+  });
+});
+```
+

package/dist/__tests__/integration/helpers.d.ts

@@ -0,0 +1,5 @@
+import type { AgentGraphInsert, AgentInsert, AgentRelationInsert } from '../../types/index';
+export declare const createTestAgentData: (tenantId: string, projectId: string, suffix: string) => AgentInsert;
+export declare const createTestRelationData: (tenantId: string, projectId: string, suffix: string) => AgentRelationInsert;
+export declare const createTestGraphData: (tenantId: string, projectId: string, suffix: string) => AgentGraphInsert;
+//# sourceMappingURL=helpers.d.ts.map

package/dist/__tests__/integration/helpers.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"helpers.d.ts","sourceRoot":"","sources":["../../../src/__tests__/integration/helpers.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,gBAAgB,EAAE,WAAW,EAAE,mBAAmB,EAAE,MAAM,mBAAmB,CAAC;AAE5F,eAAO,MAAM,mBAAmB,GAC9B,UAAU,MAAM,EAChB,WAAW,MAAM,EACjB,QAAQ,MAAM,KACb,WASF,CAAC;AAEF,eAAO,MAAM,sBAAsB,GACjC,UAAU,MAAM,EAChB,WAAW,MAAM,EACjB,QAAQ,MAAM,KACb,mBAUF,CAAC;AAEF,eAAO,MAAM,mBAAmB,GAC9B,UAAU,MAAM,EAChB,WAAW,MAAM,EACjB,QAAQ,MAAM,KACb,gBAcF,CAAC"}

package/dist/__tests__/integration/helpers.js

@@ -0,0 +1,37 @@
+export const createTestAgentData = (tenantId, projectId, suffix) => {
+    return {
+        id: `default-agent-${suffix}`,
+        tenantId,
+        projectId,
+        name: `Default Agent ${suffix}`,
+        description: 'The default agent for the graph',
+        prompt: 'Route requests appropriately',
+    };
+};
+export const createTestRelationData = (tenantId, projectId, suffix) => {
+    return {
+        id: `test-relation-${suffix}`,
+        tenantId,
+        projectId,
+        graphId: `test-graph-${suffix}`,
+        sourceAgentId: `default-agent-${suffix}`,
+        targetAgentId: `default-agent-${suffix}`,
+        relationType: 'transfer',
+    };
+};
+export const createTestGraphData = (tenantId, projectId, suffix) => {
+    return {
+        id: `test-graph-${suffix}`,
+        tenantId,
+        projectId,
+        name: `Test Agent Graph ${suffix}`,
+        description: 'A comprehensive test graph',
+        defaultAgentId: `default-agent-${suffix}`,
+        models: {
+            base: {
+                model: 'gpt-4',
+            },
+        },
+    };
+};
+//# sourceMappingURL=helpers.js.map

package/dist/__tests__/integration/helpers.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"helpers.js","sourceRoot":"","sources":["../../../src/__tests__/integration/helpers.ts"],"names":[],"mappings":"AAEA,MAAM,CAAC,MAAM,mBAAmB,GAAG,CACjC,QAAgB,EAChB,SAAiB,EACjB,MAAc,EACD,EAAE;IACf,OAAO;QACL,EAAE,EAAE,iBAAiB,MAAM,EAAE;QAC7B,QAAQ;QACR,SAAS;QACT,IAAI,EAAE,iBAAiB,MAAM,EAAE;QAC/B,WAAW,EAAE,iCAAiC;QAC9C,MAAM,EAAE,8BAA8B;KACvC,CAAC;AACJ,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,sBAAsB,GAAG,CACpC,QAAgB,EAChB,SAAiB,EACjB,MAAc,EACO,EAAE;IACvB,OAAO;QACL,EAAE,EAAE,iBAAiB,MAAM,EAAE;QAC7B,QAAQ;QACR,SAAS;QACT,OAAO,EAAE,cAAc,MAAM,EAAE;QAC/B,aAAa,EAAE,iBAAiB,MAAM,EAAE;QACxC,aAAa,EAAE,iBAAiB,MAAM,EAAE;QACxC,YAAY,EAAE,UAAmB;KAClC,CAAC;AACJ,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,mBAAmB,GAAG,CACjC,QAAgB,EAChB,SAAiB,EACjB,MAAc,EACI,EAAE;IACpB,OAAO;QACL,EAAE,EAAE,cAAc,MAAM,EAAE;QAC1B,QAAQ;QACR,SAAS;QACT,IAAI,EAAE,oBAAoB,MAAM,EAAE;QAClC,WAAW,EAAE,4BAA4B;QACzC,cAAc,EAAE,iBAAiB,MAAM,EAAE;QACzC,MAAM,EAAE;YACN,IAAI,EAAE;gBACJ,KAAK,EAAE,OAAO;aACf;SACF;KACF,CAAC;AACJ,CAAC,CAAC"}

package/dist/__tests__/setup.d.ts

@@ -0,0 +1,3 @@
+declare const dbClient: import("..").DatabaseClient;
+export { dbClient };
+//# sourceMappingURL=setup.d.ts.map

package/dist/__tests__/setup.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"setup.d.ts","sourceRoot":"","sources":["../../src/__tests__/setup.ts"],"names":[],"mappings":"AAOA,QAAA,MAAM,QAAQ,6BAA4C,CAAC;AAyB3D,OAAO,EAAE,QAAQ,EAAE,CAAC"}

package/dist/__tests__/setup.js

@@ -0,0 +1,29 @@
+import { sql } from 'drizzle-orm';
+import { migrate } from 'drizzle-orm/libsql/migrator';
+import { afterAll, afterEach, beforeAll } from 'vitest';
+import { createDatabaseClient } from '../db/client';
+import { getLogger } from '../utils/logger';
+// Create test database client using in-memory database
+const dbClient = createDatabaseClient({ url: ':memory:' });
+// Initialize database schema for in-memory test databases using Drizzle migrations
+beforeAll(async () => {
+    const logger = getLogger('Test Setup');
+    try {
+        // Temporarily disable foreign key constraints for tests due to composite key issues
+        await dbClient.run(sql `PRAGMA foreign_keys = OFF`);
+        await migrate(dbClient, { migrationsFolder: './drizzle' });
+    }
+    catch (error) {
+        logger.error({ error }, 'Failed to apply database migrations');
+        throw error;
+    }
+});
+afterEach(() => {
+    // Any cleanup if needed
+});
+afterAll(() => {
+    // Any final cleanup if needed
+});
+// Export the test database client for use in tests
+export { dbClient };
+//# sourceMappingURL=setup.js.map

package/dist/__tests__/setup.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"setup.js","sourceRoot":"","sources":["../../src/__tests__/setup.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,GAAG,EAAE,MAAM,aAAa,CAAC;AAClC,OAAO,EAAE,OAAO,EAAE,MAAM,6BAA6B,CAAC;AACtD,OAAO,EAAE,QAAQ,EAAE,SAAS,EAAE,SAAS,EAAE,MAAM,QAAQ,CAAC;AACxD,OAAO,EAAE,oBAAoB,EAAE,MAAM,cAAc,CAAC;AACpD,OAAO,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAC;AAE5C,uDAAuD;AACvD,MAAM,QAAQ,GAAG,oBAAoB,CAAC,EAAE,GAAG,EAAE,UAAU,EAAE,CAAC,CAAC;AAE3D,mFAAmF;AACnF,SAAS,CAAC,KAAK,IAAI,EAAE;IACnB,MAAM,MAAM,GAAG,SAAS,CAAC,YAAY,CAAC,CAAC;IACvC,IAAI,CAAC;QACH,oFAAoF;QACpF,MAAM,QAAQ,CAAC,GAAG,CAAC,GAAG,CAAA,2BAA2B,CAAC,CAAC;QAEnD,MAAM,OAAO,CAAC,QAAQ,EAAE,EAAE,gBAAgB,EAAE,WAAW,EAAE,CAAC,CAAC;IAC7D,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,MAAM,CAAC,KAAK,CAAC,EAAE,KAAK,EAAE,EAAE,qCAAqC,CAAC,CAAC;QAC/D,MAAM,KAAK,CAAC;IACd,CAAC;AACH,CAAC,CAAC,CAAC;AAEH,SAAS,CAAC,GAAG,EAAE;IACb,wBAAwB;AAC1B,CAAC,CAAC,CAAC;AAEH,QAAQ,CAAC,GAAG,EAAE;IACZ,8BAA8B;AAChC,CAAC,CAAC,CAAC;AAEH,mDAAmD;AACnD,OAAO,EAAE,QAAQ,EAAE,CAAC"}