@inkeep/agents-sdk 0.21.1 → 0.22.1

package/dist/index.d.cts

@@ -1,5 +1,5 @@
-import { ArtifactComponentInsert, MCPToolConfig as MCPToolConfig$1, DataComponentApiInsert, ArtifactComponentApiInsert, CredentialReferenceApiInsert, DataComponentInsert, CredentialReferenceSelect, FunctionToolConfig, SubAgentApiInsert, AgentConversationHistoryConfig, AgentStopWhen, ModelSettings, StatusUpdateSettings, FullAgentDefinition, ToolInsert, McpTransportConfig, StopWhen, SandboxConfig, FullProjectDefinition } from '@inkeep/agents-core';
-export { ANTHROPIC_MODELS, FunctionToolConfig, GOOGLE_MODELS, ModelSettings, OPENAI_MODELS, SandboxConfig } from '@inkeep/agents-core';
+import { ArtifactComponentInsert, MCPToolConfig as MCPToolConfig$1, DataComponentApiInsert, ArtifactComponentApiInsert, CredentialReferenceApiInsert, DataComponentInsert, CredentialReferenceSelect, FunctionToolConfig, SubAgentApiInsert, AgentConversationHistoryConfig, AgentStopWhen, ModelSettings, StatusUpdateSettings, FullAgentDefinition, ToolInsert, McpTransportConfig, StopWhen, FullProjectDefinition, StatusComponent as StatusComponent$1 } from '@inkeep/agents-core';
+export { ANTHROPIC_MODELS, FunctionToolConfig, GOOGLE_MODELS, ModelSettings, OPENAI_MODELS } from '@inkeep/agents-core';
 import { z } from 'zod';
 
 type ArtifactComponentConfigWithZod = Omit<ArtifactComponentInsert, 'tenantId' | 'projectId' | 'props'> & {
@@ -136,6 +136,11 @@ interface ArtifactComponentConfig extends ComponentConfig {
 interface DataComponentConfig extends ComponentConfig {
     props: Record<string, unknown> | z.ZodObject<any>;
 }
+interface StatusComponentConfig {
+    type: string;
+    description?: string;
+    detailsSchema?: Record<string, unknown> | z.ZodObject<any>;
+}
 type AgentMcpConfig = {
     server: Tool;
     selectedTools?: string[];
@@ -751,7 +756,6 @@ interface ProjectConfig {
         summarizer?: ModelSettings;
     };
     stopWhen?: StopWhen;
-    sandboxConfig?: SandboxConfig;
     agents?: () => Agent[];
     tools?: () => Tool[];
     dataComponents?: () => DataComponent[];
@@ -820,7 +824,6 @@ declare class Project implements ProjectInterface {
     private initialized;
     private models?;
     private stopWhen?;
-    private sandboxConfig?;
     private agents;
     private agentMap;
     private credentialReferences?;
@@ -924,6 +927,23 @@ declare class Project implements ProjectInterface {
     private toFullProjectDefinition;
 }
 
+type StatusComponentConfigWithZod = Omit<StatusComponent$1, 'detailsSchema'> & {
+    detailsSchema?: Record<string, unknown> | z.ZodObject<any>;
+};
+interface StatusComponentInterface {
+    config: StatusComponent$1;
+    getType(): string;
+    getDescription(): string | undefined;
+    getDetailsSchema(): StatusComponent$1['detailsSchema'];
+}
+declare class StatusComponent implements StatusComponentInterface {
+    config: StatusComponent$1;
+    constructor(config: StatusComponentConfigWithZod);
+    getType(): string;
+    getDescription(): string | undefined;
+    getDetailsSchema(): StatusComponent$1['detailsSchema'];
+}
+
 /**
  * Helper function to create agent - OpenAI style
  */
@@ -1111,6 +1131,31 @@ declare function artifactComponent(config: ArtifactComponentConfig): ArtifactCom
  * ```
  */
 declare function dataComponent(config: DataComponentConfig): DataComponent;
+/**
+ * Creates a status component for structured status updates.
+ *
+ * Status components define the structure of status updates
+ * that agents can generate during long-running operations.
+ *
+ * @param config - Status component configuration
+ * @returns A StatusComponent instance
+ *
+ * @example
+ * ```typescript
+ * import { z } from 'zod';
+ *
+ * const toolCallStatus = statusComponent({
+ *   type: 'tool_call_summary',
+ *   description: 'Summary of a tool execution',
+ *   detailsSchema: z.object({
+ *     tool_name: z.string(),
+ *     summary: z.string(),
+ *     status: z.enum(['success', 'error', 'in_progress'])
+ *   })
+ * });
+ * ```
+ */
+declare function statusComponent(config: StatusComponentConfig): StatusComponent;
 declare function agentMcp(config: AgentMcpConfig): AgentMcpConfig;
 /**
  * Creates a function tool that executes user-defined code in a sandboxed environment.
@@ -1278,4 +1323,4 @@ declare const run: typeof Runner.run;
 declare const stream: typeof Runner.stream;
 declare const raceAgents: typeof Runner.raceAgents;
 
-export { type AgentConfig, AgentError, type AgentInterface, type AgentResponse, type AgentTool, type AllSubAgentInterface, ArtifactComponent, type ArtifactComponentInterface, type ArtifactComponentWithZodProps, type AssistantMessage, type BuilderAgentConfig, type BuilderRelationConfig, type BuilderToolConfig, type CredentialReference, DataComponent, type DataComponentInterface, type DataComponentWithZodProps, ExternalAgent, type ExternalAgentInterface, type ExtractCredentialIds, type FetchDefinitionConfig, FunctionTool, type GenerateOptions, type MCPToolConfig, MaxTurnsExceededError, type Message, type MessageInput, Project, type RequestSchemaConfig, type RequestSchemaDefinition, type RunResult, Runner, type ServerConfig, type StreamEvent, type StreamResponse, SubAgent, type SubAgentCanUseType, type SubAgentConfig, type SubAgentInterface, type SystemMessage, Tool, type ToolCall, type ToolConfig, ToolExecutionError, type ToolMessage, type ToolResult, type TransferConfig, TransferError, type UnionCredentialIds, type UserMessage, agent, agentMcp, artifactComponent, createEnvironmentSettings, createFullProjectViaAPI, credential, credentialRef, dataComponent, deleteFullProjectViaAPI, externalAgent, externalAgents, functionTool, getFullProjectViaAPI, isCredentialReference, mcpServer, mcpTool, project, raceAgents, registerEnvironmentSettings, run, stream, subAgent, transfer, updateFullProjectViaAPI };
+export { type AgentConfig, AgentError, type AgentInterface, type AgentResponse, type AgentTool, type AllSubAgentInterface, ArtifactComponent, type ArtifactComponentInterface, type ArtifactComponentWithZodProps, type AssistantMessage, type BuilderAgentConfig, type BuilderRelationConfig, type BuilderToolConfig, type CredentialReference, DataComponent, type DataComponentInterface, type DataComponentWithZodProps, ExternalAgent, type ExternalAgentInterface, type ExtractCredentialIds, type FetchDefinitionConfig, FunctionTool, type GenerateOptions, type MCPToolConfig, MaxTurnsExceededError, type Message, type MessageInput, Project, type RequestSchemaConfig, type RequestSchemaDefinition, type RunResult, Runner, type ServerConfig, StatusComponent, type StatusComponentInterface, type StreamEvent, type StreamResponse, SubAgent, type SubAgentCanUseType, type SubAgentConfig, type SubAgentInterface, type SystemMessage, Tool, type ToolCall, type ToolConfig, ToolExecutionError, type ToolMessage, type ToolResult, type TransferConfig, TransferError, type UnionCredentialIds, type UserMessage, agent, agentMcp, artifactComponent, createEnvironmentSettings, createFullProjectViaAPI, credential, credentialRef, dataComponent, deleteFullProjectViaAPI, externalAgent, externalAgents, functionTool, getFullProjectViaAPI, isCredentialReference, mcpServer, mcpTool, project, raceAgents, registerEnvironmentSettings, run, statusComponent, stream, subAgent, transfer, updateFullProjectViaAPI };

package/dist/index.d.ts

@@ -1,5 +1,5 @@
-import { ArtifactComponentInsert, MCPToolConfig as MCPToolConfig$1, DataComponentApiInsert, ArtifactComponentApiInsert, CredentialReferenceApiInsert, DataComponentInsert, CredentialReferenceSelect, FunctionToolConfig, SubAgentApiInsert, AgentConversationHistoryConfig, AgentStopWhen, ModelSettings, StatusUpdateSettings, FullAgentDefinition, ToolInsert, McpTransportConfig, StopWhen, SandboxConfig, FullProjectDefinition } from '@inkeep/agents-core';
-export { ANTHROPIC_MODELS, FunctionToolConfig, GOOGLE_MODELS, ModelSettings, OPENAI_MODELS, SandboxConfig } from '@inkeep/agents-core';
+import { ArtifactComponentInsert, MCPToolConfig as MCPToolConfig$1, DataComponentApiInsert, ArtifactComponentApiInsert, CredentialReferenceApiInsert, DataComponentInsert, CredentialReferenceSelect, FunctionToolConfig, SubAgentApiInsert, AgentConversationHistoryConfig, AgentStopWhen, ModelSettings, StatusUpdateSettings, FullAgentDefinition, ToolInsert, McpTransportConfig, StopWhen, FullProjectDefinition, StatusComponent as StatusComponent$1 } from '@inkeep/agents-core';
+export { ANTHROPIC_MODELS, FunctionToolConfig, GOOGLE_MODELS, ModelSettings, OPENAI_MODELS } from '@inkeep/agents-core';
 import { z } from 'zod';
 
 type ArtifactComponentConfigWithZod = Omit<ArtifactComponentInsert, 'tenantId' | 'projectId' | 'props'> & {
@@ -136,6 +136,11 @@ interface ArtifactComponentConfig extends ComponentConfig {
 interface DataComponentConfig extends ComponentConfig {
     props: Record<string, unknown> | z.ZodObject<any>;
 }
+interface StatusComponentConfig {
+    type: string;
+    description?: string;
+    detailsSchema?: Record<string, unknown> | z.ZodObject<any>;
+}
 type AgentMcpConfig = {
     server: Tool;
     selectedTools?: string[];
@@ -751,7 +756,6 @@ interface ProjectConfig {
         summarizer?: ModelSettings;
     };
     stopWhen?: StopWhen;
-    sandboxConfig?: SandboxConfig;
     agents?: () => Agent[];
     tools?: () => Tool[];
     dataComponents?: () => DataComponent[];
@@ -820,7 +824,6 @@ declare class Project implements ProjectInterface {
     private initialized;
     private models?;
     private stopWhen?;
-    private sandboxConfig?;
     private agents;
     private agentMap;
     private credentialReferences?;
@@ -924,6 +927,23 @@ declare class Project implements ProjectInterface {
     private toFullProjectDefinition;
 }
 
+type StatusComponentConfigWithZod = Omit<StatusComponent$1, 'detailsSchema'> & {
+    detailsSchema?: Record<string, unknown> | z.ZodObject<any>;
+};
+interface StatusComponentInterface {
+    config: StatusComponent$1;
+    getType(): string;
+    getDescription(): string | undefined;
+    getDetailsSchema(): StatusComponent$1['detailsSchema'];
+}
+declare class StatusComponent implements StatusComponentInterface {
+    config: StatusComponent$1;
+    constructor(config: StatusComponentConfigWithZod);
+    getType(): string;
+    getDescription(): string | undefined;
+    getDetailsSchema(): StatusComponent$1['detailsSchema'];
+}
+
 /**
  * Helper function to create agent - OpenAI style
  */
@@ -1111,6 +1131,31 @@ declare function artifactComponent(config: ArtifactComponentConfig): ArtifactCom
  * ```
  */
 declare function dataComponent(config: DataComponentConfig): DataComponent;
+/**
+ * Creates a status component for structured status updates.
+ *
+ * Status components define the structure of status updates
+ * that agents can generate during long-running operations.
+ *
+ * @param config - Status component configuration
+ * @returns A StatusComponent instance
+ *
+ * @example
+ * ```typescript
+ * import { z } from 'zod';
+ *
+ * const toolCallStatus = statusComponent({
+ *   type: 'tool_call_summary',
+ *   description: 'Summary of a tool execution',
+ *   detailsSchema: z.object({
+ *     tool_name: z.string(),
+ *     summary: z.string(),
+ *     status: z.enum(['success', 'error', 'in_progress'])
+ *   })
+ * });
+ * ```
+ */
+declare function statusComponent(config: StatusComponentConfig): StatusComponent;
 declare function agentMcp(config: AgentMcpConfig): AgentMcpConfig;
 /**
  * Creates a function tool that executes user-defined code in a sandboxed environment.
@@ -1278,4 +1323,4 @@ declare const run: typeof Runner.run;
 declare const stream: typeof Runner.stream;
 declare const raceAgents: typeof Runner.raceAgents;
 
-export { type AgentConfig, AgentError, type AgentInterface, type AgentResponse, type AgentTool, type AllSubAgentInterface, ArtifactComponent, type ArtifactComponentInterface, type ArtifactComponentWithZodProps, type AssistantMessage, type BuilderAgentConfig, type BuilderRelationConfig, type BuilderToolConfig, type CredentialReference, DataComponent, type DataComponentInterface, type DataComponentWithZodProps, ExternalAgent, type ExternalAgentInterface, type ExtractCredentialIds, type FetchDefinitionConfig, FunctionTool, type GenerateOptions, type MCPToolConfig, MaxTurnsExceededError, type Message, type MessageInput, Project, type RequestSchemaConfig, type RequestSchemaDefinition, type RunResult, Runner, type ServerConfig, type StreamEvent, type StreamResponse, SubAgent, type SubAgentCanUseType, type SubAgentConfig, type SubAgentInterface, type SystemMessage, Tool, type ToolCall, type ToolConfig, ToolExecutionError, type ToolMessage, type ToolResult, type TransferConfig, TransferError, type UnionCredentialIds, type UserMessage, agent, agentMcp, artifactComponent, createEnvironmentSettings, createFullProjectViaAPI, credential, credentialRef, dataComponent, deleteFullProjectViaAPI, externalAgent, externalAgents, functionTool, getFullProjectViaAPI, isCredentialReference, mcpServer, mcpTool, project, raceAgents, registerEnvironmentSettings, run, stream, subAgent, transfer, updateFullProjectViaAPI };
+export { type AgentConfig, AgentError, type AgentInterface, type AgentResponse, type AgentTool, type AllSubAgentInterface, ArtifactComponent, type ArtifactComponentInterface, type ArtifactComponentWithZodProps, type AssistantMessage, type BuilderAgentConfig, type BuilderRelationConfig, type BuilderToolConfig, type CredentialReference, DataComponent, type DataComponentInterface, type DataComponentWithZodProps, ExternalAgent, type ExternalAgentInterface, type ExtractCredentialIds, type FetchDefinitionConfig, FunctionTool, type GenerateOptions, type MCPToolConfig, MaxTurnsExceededError, type Message, type MessageInput, Project, type RequestSchemaConfig, type RequestSchemaDefinition, type RunResult, Runner, type ServerConfig, StatusComponent, type StatusComponentInterface, type StreamEvent, type StreamResponse, SubAgent, type SubAgentCanUseType, type SubAgentConfig, type SubAgentInterface, type SystemMessage, Tool, type ToolCall, type ToolConfig, ToolExecutionError, type ToolMessage, type ToolResult, type TransferConfig, TransferError, type UnionCredentialIds, type UserMessage, agent, agentMcp, artifactComponent, createEnvironmentSettings, createFullProjectViaAPI, credential, credentialRef, dataComponent, deleteFullProjectViaAPI, externalAgent, externalAgents, functionTool, getFullProjectViaAPI, isCredentialReference, mcpServer, mcpTool, project, raceAgents, registerEnvironmentSettings, run, statusComponent, stream, subAgent, transfer, updateFullProjectViaAPI };