@inkeep/agents-sdk 0.1.6 → 0.1.8

package/dist/index.d.ts

@@ -1,4 +1,4 @@
-import { MCPToolConfig as MCPToolConfig$1, CredentialReferenceApiInsert, MCPTransportType, CredentialReferenceSelect, AgentApiInsert, DataComponentApiInsert, ArtifactComponentApiInsert, AgentConversationHistoryConfig, ToolInsert, McpTransportConfig, ArtifactComponentInsert, DataComponentInsert } from '@inkeep/agents-core';
+import { MCPToolConfig as MCPToolConfig$1, CredentialReferenceApiInsert, MCPTransportType, CredentialReferenceSelect, AgentApiInsert, AgentStopWhen, DataComponentApiInsert, ArtifactComponentApiInsert, AgentConversationHistoryConfig, GraphStopWhen, ToolInsert, McpTransportConfig, ArtifactComponentInsert, DataComponentInsert, StopWhen, FullProjectDefinition } from '@inkeep/agents-core';
 import { z } from 'zod';
 
 interface ToolInterface {
@@ -97,7 +97,7 @@ type AgentMcpConfig = {
 declare function transfer(targetAgent: Agent, description?: string, condition?: TransferConditionFunction): TransferConfig;
 
 type ExternalAgentConfig = {
-    type?: "external";
+    type?: 'external';
     tenantId?: string;
     id: string;
     name: string;
@@ -149,28 +149,28 @@ declare function externalAgent(config: ExternalAgentConfig): ExternalAgent;
 declare function externalAgents(configs: Record<string, ExternalAgentConfig>): Record<string, ExternalAgent>;
 
 interface UserMessage {
-    role: "user";
+    role: 'user';
     content: string;
 }
 interface AssistantMessage {
-    role: "assistant";
+    role: 'assistant';
     content: string;
     toolCalls?: ToolCall[];
 }
 interface ToolMessage {
-    role: "tool";
+    role: 'tool';
     content: string;
     toolCallId: string;
 }
 interface SystemMessage {
-    role: "system";
+    role: 'system';
     content: string;
 }
 type Message = UserMessage | AssistantMessage | ToolMessage | SystemMessage;
 type MessageInput = string | string[] | Message | Message[];
 interface ToolCall {
     id: string;
-    type: "function";
+    type: 'function';
     function: {
         name: string;
         arguments: string;
@@ -183,8 +183,8 @@ interface ToolResult {
 }
 type AllAgentInterface = AgentInterface | ExternalAgentInterface;
 type AgentCanUseType = Tool | AgentMcpConfig;
-interface AgentConfig extends Omit<AgentApiInsert, "projectId"> {
-    type?: "internal";
+interface AgentConfig extends Omit<AgentApiInsert, 'projectId'> {
+    type?: 'internal';
     canUse?: () => AgentCanUseType[];
     canTransferTo?: () => AgentInterface[];
     canDelegateTo?: () => AllAgentInterface[];
@@ -195,11 +195,9 @@ interface AgentConfig extends Omit<AgentApiInsert, "projectId"> {
         structuredOutput?: ModelSettings;
         summarizer?: ModelSettings;
     };
-    stopWhen?: {
-        stepCountIs?: number;
-    };
+    stopWhen?: AgentStopWhen;
     memory?: {
-        type: "conversation" | "episodic" | "short_term";
+        type: 'conversation' | 'episodic' | 'short_term';
         capacity?: number;
     };
     dataComponents?: () => DataComponentApiInsert[];
@@ -234,14 +232,14 @@ interface MCPToolConfig {
     toolName?: string;
     activeTools?: string[];
     headers?: Record<string, string>;
-    mcpType?: "nango" | "generic";
+    mcpType?: 'nango' | 'generic';
     transport?: McpTransportConfig;
     imageUrl?: string;
 }
 interface FetchDefinitionConfig {
     id: string;
     name?: string;
-    trigger: "initialization" | "invocation";
+    trigger: 'initialization' | 'invocation';
     url: string;
     method?: string;
     headers?: Record<string, string>;
@@ -260,7 +258,7 @@ interface RequestSchemaDefinition {
 }
 interface RequestSchemaConfig {
     schemas: RequestSchemaDefinition;
-    optional?: ("body" | "headers" | "query" | "params")[];
+    optional?: ('body' | 'headers' | 'query' | 'params')[];
 }
 interface TransferConfig {
     agent: AgentInterface;
@@ -271,7 +269,7 @@ interface GenerateOptions {
     maxTurns?: number;
     maxSteps?: number;
     temperature?: number;
-    toolChoice?: "auto" | "none" | string;
+    toolChoice?: 'auto' | 'none' | string;
     resourceId?: string;
     conversationId?: string;
     stream?: boolean;
@@ -282,7 +280,7 @@ interface AgentResponse {
     text: string;
     toolCalls?: ToolCall[];
     transfer?: TransferConfig;
-    finishReason: "completed" | "tool_calls" | "transfer" | "max_turns" | "error";
+    finishReason: 'completed' | 'tool_calls' | 'transfer' | 'max_turns' | 'error';
     usage?: {
         inputTokens: number;
         outputTokens: number;
@@ -295,7 +293,7 @@ interface StreamResponse {
     eventStream?: AsyncGenerator<StreamEvent>;
 }
 interface StreamEvent {
-    type: "text" | "tool_call" | "transfer" | "error" | "done";
+    type: 'text' | 'tool_call' | 'transfer' | 'error' | 'done';
     data: any;
     timestamp: Date;
 }
@@ -319,7 +317,7 @@ interface StatusComponent {
     type: string;
     description?: string;
     schema: {
-        type: "object";
+        type: 'object';
         properties: Record<string, any>;
         required?: string[];
     };
@@ -341,9 +339,7 @@ interface GraphConfig {
     tenantId?: string;
     contextConfig?: any;
     credentials?: () => CredentialReferenceApiInsert[];
-    stopWhen?: {
-        transferCountIs?: number;
-    };
+    stopWhen?: GraphStopWhen;
     graphPrompt?: string;
     models?: {
         base?: ModelSettings;
@@ -368,7 +364,7 @@ declare class TransferError extends AgentError {
 }
 interface AgentInterface {
     config: AgentConfig;
-    type: "internal";
+    type: 'internal';
     init(): Promise<void>;
     getId(): string;
     getName(): string;
@@ -384,7 +380,7 @@ interface AgentInterface {
 }
 interface ExternalAgentInterface {
     config: ExternalAgentConfig;
-    type: "external";
+    type: 'external';
     init(): Promise<void>;
     getId(): string;
     getName(): string;
@@ -411,7 +407,7 @@ interface BuilderToolConfig {
     name: string;
     description: string;
     config: {
-        type: "mcp";
+        type: 'mcp';
         mcp: {
             server: {
                 url: string;
@@ -422,7 +418,7 @@ interface BuilderToolConfig {
 }
 interface BuilderRelationConfig {
     targetAgent: string;
-    relationType: "transfer" | "delegate";
+    relationType: 'transfer' | 'delegate';
 }
 interface BuilderAgentConfig {
     name: string;
@@ -469,13 +465,13 @@ declare class Agent implements AgentInterface {
 }
 
 interface ArtifactComponentInterface {
-    config: Omit<ArtifactComponentInsert, "id">;
+    config: Omit<ArtifactComponentInsert, 'id'>;
     init(): Promise<void>;
-    getId(): ArtifactComponentInsert["id"];
-    getName(): ArtifactComponentInsert["name"];
-    getDescription(): ArtifactComponentInsert["description"];
-    getSummaryProps(): ArtifactComponentInsert["summaryProps"];
-    getFullProps(): ArtifactComponentInsert["fullProps"];
+    getId(): ArtifactComponentInsert['id'];
+    getName(): ArtifactComponentInsert['name'];
+    getDescription(): ArtifactComponentInsert['description'];
+    getSummaryProps(): ArtifactComponentInsert['summaryProps'];
+    getFullProps(): ArtifactComponentInsert['fullProps'];
 }
 declare class ArtifactComponent implements ArtifactComponentInterface {
     config: ArtifactComponentInsert;
@@ -484,23 +480,23 @@ declare class ArtifactComponent implements ArtifactComponentInterface {
     private projectId;
     private initialized;
     private id;
-    constructor(config: Omit<ArtifactComponentInsert, "id">);
+    constructor(config: Omit<ArtifactComponentInsert, 'id'>);
     getId(): string;
     getName(): string;
     getDescription(): string;
-    getSummaryProps(): ArtifactComponentInsert["summaryProps"];
-    getFullProps(): ArtifactComponentInsert["fullProps"];
+    getSummaryProps(): ArtifactComponentInsert['summaryProps'];
+    getFullProps(): ArtifactComponentInsert['fullProps'];
     init(): Promise<void>;
     private upsertArtifactComponent;
 }
 
 interface DataComponentInterface {
-    config: Omit<DataComponentInsert, "id">;
+    config: Omit<DataComponentInsert, 'id'>;
     init(): Promise<void>;
-    getId(): DataComponentInsert["id"];
-    getName(): DataComponentInsert["name"];
-    getDescription(): DataComponentInsert["description"];
-    getProps(): DataComponentInsert["props"];
+    getId(): DataComponentInsert['id'];
+    getName(): DataComponentInsert['name'];
+    getDescription(): DataComponentInsert['description'];
+    getProps(): DataComponentInsert['props'];
 }
 declare class DataComponent implements DataComponentInterface {
     config: DataComponentInsert;
@@ -509,11 +505,11 @@ declare class DataComponent implements DataComponentInterface {
     private projectId;
     private initialized;
     private id;
-    constructor(config: Omit<DataComponentInsert, "id">);
+    constructor(config: Omit<DataComponentInsert, 'id'>);
     getId(): string;
     getName(): string;
     getDescription(): string;
-    getProps(): DataComponentInsert["props"];
+    getProps(): DataComponentInsert['props'];
     init(): Promise<void>;
     private upsertDataComponent;
 }
@@ -625,9 +621,7 @@ declare class AgentGraph implements GraphInterface {
     /**
      * Get the graph's stopWhen configuration
      */
-    getStopWhen(): {
-        transferCountIs?: number;
-    };
+    getStopWhen(): GraphStopWhen;
     /**
      * Get the graph's status updates configuration
      */
@@ -709,10 +703,206 @@ declare class AgentGraph implements GraphInterface {
     private createExternalAgents;
 }
 
+/**
+ * Project configuration interface for the SDK
+ */
+interface ProjectConfig {
+    id: string;
+    name: string;
+    description?: string;
+    tenantId?: string;
+    models?: {
+        base?: ModelSettings;
+        structuredOutput?: ModelSettings;
+        summarizer?: ModelSettings;
+    };
+    stopWhen?: StopWhen;
+    graphs?: () => AgentGraph[];
+}
+/**
+ * Project interface for operations
+ */
+interface ProjectInterface {
+    init(): Promise<void>;
+    setConfig(tenantId: string, apiUrl: string): void;
+    getId(): string;
+    getName(): string;
+    getDescription(): string | undefined;
+    getTenantId(): string;
+    getModels(): ProjectConfig['models'];
+    getStopWhen(): ProjectConfig['stopWhen'];
+    getGraphs(): AgentGraph[];
+    addGraph(graph: AgentGraph): void;
+    removeGraph(id: string): boolean;
+    getStats(): {
+        projectId: string;
+        tenantId: string;
+        graphCount: number;
+        initialized: boolean;
+    };
+    validate(): {
+        valid: boolean;
+        errors: string[];
+    };
+}
+/**
+ * Project class for managing agent projects
+ *
+ * Projects are the top-level organizational unit that contains graphs, agents, and shared configurations.
+ * They provide model inheritance and execution limits that cascade down to graphs and agents.
+ *
+ * @example
+ * ```typescript
+ * const myProject = new Project({
+ *   id: 'customer-support-project',
+ *   name: 'Customer Support System',
+ *   description: 'Multi-agent customer support system',
+ *   models: {
+ *     base: { model: 'gpt-4o-mini' },
+ *     structuredOutput: { model: 'gpt-4o' }
+ *   },
+ *   stopWhen: {
+ *     transferCountIs: 10,
+ *     stepCountIs: 50
+ *   }
+ * });
+ *
+ * await myProject.init();
+ * ```
+ */
+declare class Project implements ProjectInterface {
+    private projectId;
+    private projectName;
+    private projectDescription?;
+    private tenantId;
+    private baseURL;
+    private initialized;
+    private models?;
+    private stopWhen?;
+    private graphs;
+    private graphMap;
+    constructor(config: ProjectConfig);
+    /**
+     * Set or update the configuration (tenantId and apiUrl)
+     * This is used by the CLI to inject configuration from inkeep.config.ts
+     */
+    setConfig(tenantId: string, apiUrl: string): void;
+    /**
+     * Initialize the project and create/update it in the backend using full project approach
+     */
+    init(): Promise<void>;
+    /**
+     * Get the project ID
+     */
+    getId(): string;
+    /**
+     * Get the project name
+     */
+    getName(): string;
+    /**
+     * Get the project description
+     */
+    getDescription(): string | undefined;
+    /**
+     * Get the tenant ID
+     */
+    getTenantId(): string;
+    /**
+     * Get the project's model configuration
+     */
+    getModels(): ProjectConfig['models'];
+    /**
+     * Set the project's model configuration
+     */
+    setModels(models: ProjectConfig['models']): void;
+    /**
+     * Get the project's stopWhen configuration
+     */
+    getStopWhen(): ProjectConfig['stopWhen'];
+    /**
+     * Set the project's stopWhen configuration
+     */
+    setStopWhen(stopWhen: ProjectConfig['stopWhen']): void;
+    /**
+     * Get all graphs in the project
+     */
+    getGraphs(): AgentGraph[];
+    /**
+     * Get a graph by ID
+     */
+    getGraph(id: string): AgentGraph | undefined;
+    /**
+     * Add a graph to the project
+     */
+    addGraph(graph: AgentGraph): void;
+    /**
+     * Remove a graph from the project
+     */
+    removeGraph(id: string): boolean;
+    /**
+     * Get project statistics
+     */
+    getStats(): {
+        projectId: string;
+        tenantId: string;
+        graphCount: number;
+        initialized: boolean;
+    };
+    /**
+     * Validate the project configuration
+     */
+    validate(): {
+        valid: boolean;
+        errors: string[];
+    };
+    /**
+     * Convert the Project to FullProjectDefinition format
+     */
+    private toFullProjectDefinition;
+    /**
+     * Convert project configuration to API format
+     */
+    private toApiFormat;
+}
+
 /**
  * Helper function to create graphs - OpenAI style
  */
 declare function agentGraph(config: GraphConfig): AgentGraph;
+/**
+ * Helper function to create projects - OpenAI style
+ *
+ * Projects are the top-level organizational unit that contains graphs, agents, and shared configurations.
+ * They provide model inheritance and execution limits that cascade down to graphs and agents.
+ *
+ * @param config - Project configuration
+ * @returns A new Project instance
+ *
+ * @example
+ * ```typescript
+ * const customerSupport = project({
+ *   id: 'customer-support-project',
+ *   name: 'Customer Support System',
+ *   description: 'Multi-agent customer support system',
+ *   models: {
+ *     base: { model: 'gpt-4o-mini' },
+ *     structuredOutput: { model: 'gpt-4o' }
+ *   },
+ *   stopWhen: {
+ *     transferCountIs: 10,
+ *     stepCountIs: 50
+ *   },
+ *   graphs: () => [
+ *     agentGraph({
+ *       id: 'support-graph',
+ *       name: 'Support Graph',
+ *       // ... graph config
+ *     })
+ *   ]
+ * });
+ * ```
+ */
+declare function project(config: ProjectConfig): Project;
 /**
  * Creates a new agent with stable ID enforcement.
  *
@@ -879,6 +1069,28 @@ declare function createEnvironmentSettings<T extends Record<string, EnvironmentS
  */
 declare function registerEnvironmentSettings<T extends EnvironmentSettingsConfig>(config: T): T;
 
+/**
+ * Client-side functions for interacting with the Full Project API
+ * These functions make HTTP requests to the server instead of direct database calls
+ */
+
+/**
+ * Create a full project via HTTP API
+ */
+declare function createFullProjectViaAPI(tenantId: string, apiUrl: string, projectData: FullProjectDefinition): Promise<FullProjectDefinition>;
+/**
+ * Update a full project via HTTP API (upsert behavior)
+ */
+declare function updateFullProjectViaAPI(tenantId: string, apiUrl: string, projectId: string, projectData: FullProjectDefinition): Promise<FullProjectDefinition>;
+/**
+ * Get a full project via HTTP API
+ */
+declare function getFullProjectViaAPI(tenantId: string, apiUrl: string, projectId: string): Promise<FullProjectDefinition | null>;
+/**
+ * Delete a full project via HTTP API
+ */
+declare function deleteFullProjectViaAPI(tenantId: string, apiUrl: string, projectId: string): Promise<void>;
+
 declare class Runner {
     /**
      * Run a graph until completion, handling transfers and tool calls
@@ -916,4 +1128,4 @@ declare const run: typeof Runner.run;
 declare const stream: typeof Runner.stream;
 declare const raceGraphs: typeof Runner.raceGraphs;
 
-export { Agent, type AgentCanUseType, type AgentConfig, AgentError, type AgentInterface, type AgentResponse, type AllAgentInterface, ArtifactComponent, type AssistantMessage, type BuilderAgentConfig, type BuilderRelationConfig, type BuilderToolConfig, DataComponent, ExternalAgent, type ExternalAgentInterface, type FetchDefinitionConfig, type GenerateOptions, type GraphConfig, type GraphInterface, type MCPToolConfig, MaxTurnsExceededError, type Message, type MessageInput, type ModelSettings, ModelSettingsSchema, type RequestSchemaConfig, type RequestSchemaDefinition, type RunResult, Runner, type ServerConfig, type StatusComponent, type StatusUpdateSettings, type StreamEvent, type StreamResponse, type SystemMessage, Tool, type ToolCall, type ToolConfig, ToolExecutionError, type ToolMessage, type ToolResult, type TransferConfig, TransferError, type UserMessage, agent, agentGraph, agentMcp, artifactComponent, createEnvironmentSettings, credential, dataComponent, externalAgent, externalAgents, mcpServer, mcpTool, raceGraphs, registerEnvironmentSettings, run, stream, transfer };
+export { Agent, type AgentCanUseType, type AgentConfig, AgentError, type AgentInterface, type AgentResponse, type AllAgentInterface, ArtifactComponent, type AssistantMessage, type BuilderAgentConfig, type BuilderRelationConfig, type BuilderToolConfig, DataComponent, ExternalAgent, type ExternalAgentInterface, type FetchDefinitionConfig, type GenerateOptions, type GraphConfig, type GraphInterface, type MCPToolConfig, MaxTurnsExceededError, type Message, type MessageInput, type ModelSettings, ModelSettingsSchema, Project, type RequestSchemaConfig, type RequestSchemaDefinition, type RunResult, Runner, type ServerConfig, type StatusComponent, type StatusUpdateSettings, type StreamEvent, type StreamResponse, type SystemMessage, Tool, type ToolCall, type ToolConfig, ToolExecutionError, type ToolMessage, type ToolResult, type TransferConfig, TransferError, type UserMessage, agent, agentGraph, agentMcp, artifactComponent, createEnvironmentSettings, createFullProjectViaAPI, credential, dataComponent, deleteFullProjectViaAPI, externalAgent, externalAgents, getFullProjectViaAPI, mcpServer, mcpTool, project, raceGraphs, registerEnvironmentSettings, run, stream, transfer, updateFullProjectViaAPI };