@inkeep/agents-core 0.0.0-chat-to-edit-20251119071712

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,458 @@
+# @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;
+  subAgentId: 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',
+  subAgentId: '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
+# Run migrations
+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:
+
+### Agents Manage API
+Handles CRUD operations and entity management:
+- Creating/updating agents
+- Managing agent relationships
+- Configuring tools
+- Database migrations
+
+### Agents Run 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
+  agent: one(agents, {
+    fields: [workflows.agentId],
+    references: [agents.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: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/SUPPLEMENTAL_TERMS.md

@@ -0,0 +1,40 @@
+<!--
+AUTO-GENERATED FILE - DO NOT EDIT DIRECTLY
+Source: ./SUPPLEMENTAL_TERMS.md
+This file is automatically copied from the root SUPPLEMENTAL_TERMS.md during build.
+Any changes should be made to the root SUPPLEMENTAL_TERMS.md file.
+-->
+
+# Inkeep SDK – Elastic License 2.0 with Supplemental Terms
+
+The Inkeep [SDK] (the "Software") is licensed under the Elastic License 2.0 ("ELv2"), available at [https://www.elastic.co/licensing/elastic-license](https://www.elastic.co/licensing/elastic-license), subject to the supplemental terms below. By using the Software, you, your company, and your licensees agree to both ELv2 and these Supplemental Terms – for purposes of these Supplemental Terms, references to "you" have the same meaning as in ELv2 and include your company and contractors acting on your behalf. In the event of conflict, these Supplemental Terms control.
+
+Any copy or redistribution of the Software must include both the ELv2 license reference and these Supplemental Terms.
+
+## 1. Restrictions
+
+### 1.1
+You may not use the Software, directly or indirectly, to offer, enable, operate, or provide any Agent Builder.
+
+### 1.2
+You may not repackage, rebrand, or otherwise expose the Software's agent-creation or orchestration functionality for third-party use, including in specialized or verticalized offerings that present substantially similar functionality to the Software.
+
+### 1.3
+For clarity, the foregoing restrictions do not prohibit your use of the Software as Embedded Assistants or Professional Services, provided neither allow third parties to create, configure, train, orchestrate, deploy, or manage their own agents or agent workflows.
+
+## 2. Definitions
+
+### 2.1 Inkeep
+**"Inkeep"** means Inkeep, Inc., a Delaware corporation with principal offices at 169 Madison Ave, Ste 2544, New York, NY, 10016, the licensor (as defined in ELv2) of the Software.
+
+### 2.2 Agent Builder
+**"Agent Builder"** means any hosted or on-premise product, platform, UI or API that allows third parties (e.g., customers, developers, or community users other than your personnel) to create, configure, compose, train, orchestrate, deploy, or manage their own Agents using the Software, or that otherwise exposes a substantial set of the Agent-creation and orchestration functionality of the Software.
+
+### 2.3 Agents
+**"Agents"** means autonomous, semi-autonomous, or automated systems — including assistants, copilots, workflows, orchestrations, or other systems powered by or incorporating artificial intelligence, machine learning, large language models, or related technologies.
+
+### 2.4 Embedded Assistant
+**"Embedded Assistant"** means embedding the Software in your own products or services to power a specific assistant/copilot/agent experience for you or your end users (e.g., a support bot in your app or an internal helpdesk agent), where end users do not receive access to any substantial set of the Software's agent-creation or orchestration features.
+
+### 2.5 Professional Services
+**"Professional Services"** means using the Software to deliver a bespoke solution to a single client where only your personnel operate the Software, the client receives access solely to the resulting assistant within the client's environment and not to the agent-creation/orchestration features of the Software, and no multi-tenant or self-service builder is provided.