@inkeep/agents-sdk 0.3.0 → 0.6.0

package/dist/index.d.cts

@@ -1,4 +1,4 @@
-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 { MCPToolConfig as MCPToolConfig$1, CredentialReferenceApiInsert, CredentialReferenceSelect, DataComponentInsert, ArtifactComponentInsert, AgentApiInsert, AgentStopWhen, DataComponentApiInsert, ArtifactComponentApiInsert, AgentConversationHistoryConfig, GraphStopWhen, StatusUpdateSettings, ToolInsert, McpTransportConfig, StopWhen, FullProjectDefinition } from '@inkeep/agents-core';
 import { z } from 'zod';
 
 interface ToolInterface {
@@ -17,7 +17,8 @@ declare class Tool implements ToolInterface {
     private tenantId;
     private initialized;
     private projectId;
-    constructor(config: MCPToolConfig$1);
+    constructor(config: Omit<MCPToolConfig$1, 'tenantId' | 'projectId'>);
+    setContext(tenantId: string, projectId: string): void;
     getId(): string;
     getName(): string;
     getDescription(): string;
@@ -44,8 +45,7 @@ interface MCPServerConfig {
     id?: string;
     parameters?: Record<string, z.ZodJSONSchema>;
     credential?: CredentialReferenceApiInsert;
-    tenantId?: string;
-    transport?: keyof typeof MCPTransportType;
+    transport?: 'streamable_http' | 'sse';
     activeTools?: string[];
     headers?: Record<string, string>;
     imageUrl?: string;
@@ -54,10 +54,9 @@ interface MCPServerConfig {
  * Configuration for component builders
  */
 interface ComponentConfig {
+    id?: string;
     name: string;
     description: string;
-    tenantId?: string;
-    projectId?: string;
 }
 interface ArtifactComponentConfig extends ComponentConfig {
     summaryProps: Record<string, unknown>;
@@ -98,7 +97,6 @@ declare function transfer(targetAgent: Agent, description?: string, condition?:
 
 type ExternalAgentConfig = {
     type?: 'external';
-    tenantId?: string;
     id: string;
     name: string;
     description: string;
@@ -117,6 +115,7 @@ declare class ExternalAgent implements ExternalAgentInterface {
      * Initialize the external agent by upserting it in the database
      */
     init(): Promise<void>;
+    setContext(tenantId: string): void;
     getId(): string;
     private upsertExternalAgent;
     /**
@@ -148,6 +147,60 @@ declare function externalAgent(config: ExternalAgentConfig): ExternalAgent;
  */
 declare function externalAgents(configs: Record<string, ExternalAgentConfig>): Record<string, ExternalAgent>;
 
+interface DataComponentInterface {
+    config: Omit<DataComponentInsert, 'tenantId' | 'projectId'>;
+    init(): Promise<void>;
+    getId(): DataComponentInsert['id'];
+    getName(): DataComponentInsert['name'];
+    getDescription(): DataComponentInsert['description'];
+    getProps(): DataComponentInsert['props'];
+    setContext(tenantId: string, projectId: string): void;
+}
+declare class DataComponent implements DataComponentInterface {
+    config: Omit<DataComponentInsert, 'tenantId' | 'projectId'>;
+    private baseURL;
+    private tenantId;
+    private projectId;
+    private initialized;
+    private id;
+    constructor(config: Omit<DataComponentInsert, 'tenantId' | 'projectId'>);
+    setContext(tenantId: string, projectId: string): void;
+    getId(): string;
+    getName(): string;
+    getDescription(): string;
+    getProps(): DataComponentInsert['props'];
+    init(): Promise<void>;
+    private upsertDataComponent;
+}
+
+interface ArtifactComponentInterface {
+    config: Omit<ArtifactComponentInsert, 'tenantId' | 'projectId'>;
+    init(): Promise<void>;
+    getId(): ArtifactComponentInsert['id'];
+    getName(): ArtifactComponentInsert['name'];
+    getDescription(): ArtifactComponentInsert['description'];
+    getSummaryProps(): ArtifactComponentInsert['summaryProps'];
+    getFullProps(): ArtifactComponentInsert['fullProps'];
+    setContext(tenantId: string, projectId: string): void;
+}
+declare class ArtifactComponent implements ArtifactComponentInterface {
+    config: Omit<ArtifactComponentInsert, 'tenantId' | 'projectId'>;
+    private baseURL;
+    private tenantId;
+    private projectId;
+    private initialized;
+    private id;
+    constructor(config: Omit<ArtifactComponentInsert, 'tenantId' | 'projectId'>);
+    setContext(tenantId: string, projectId: string): void;
+    getId(): string;
+    getName(): string;
+    getDescription(): string;
+    getSummaryProps(): ArtifactComponentInsert['summaryProps'];
+    getFullProps(): ArtifactComponentInsert['fullProps'];
+    init(): Promise<void>;
+    private upsertArtifactComponent;
+}
+
 interface UserMessage {
     role: 'user';
     content: string;
@@ -188,8 +241,6 @@ interface AgentConfig extends Omit<AgentApiInsert, 'projectId'> {
     canUse?: () => AgentCanUseType[];
     canTransferTo?: () => AgentInterface[];
     canDelegateTo?: () => AllAgentInterface[];
-    tenantId?: string;
-    projectId?: string;
     models?: {
         base?: ModelSettings;
         structuredOutput?: ModelSettings;
@@ -200,8 +251,8 @@ interface AgentConfig extends Omit<AgentApiInsert, 'projectId'> {
         type: 'conversation' | 'episodic' | 'short_term';
         capacity?: number;
     };
-    dataComponents?: () => DataComponentApiInsert[];
-    artifactComponents?: () => ArtifactComponentApiInsert[];
+    dataComponents?: () => (DataComponentApiInsert | DataComponentInterface)[];
+    artifactComponents?: () => (ArtifactComponentApiInsert | ArtifactComponentInterface)[];
     conversationHistoryConfig?: AgentConversationHistoryConfig;
 }
 interface ModelSettings {
@@ -311,30 +362,12 @@ interface RunResult {
         transfers: TransferConfig[];
     };
 }
-interface StatusComponent {
-    type: string;
-    description?: string;
-    schema?: {
-        type: 'object';
-        properties: Record<string, any>;
-        required?: string[];
-    };
-}
-interface StatusUpdateSettings {
-    enabled?: boolean;
-    numEvents?: number;
-    timeInSeconds?: number;
-    model?: string;
-    statusComponents?: StatusComponent[];
-    prompt?: string;
-}
 interface GraphConfig {
     id: string;
     name?: string;
     description?: string;
     defaultAgent?: AgentInterface;
     agents?: () => AllAgentInterface[];
-    tenantId?: string;
     contextConfig?: any;
     credentials?: () => CredentialReferenceApiInsert[];
     stopWhen?: GraphStopWhen;
@@ -373,6 +406,7 @@ interface AgentInterface {
     getDelegates(): AllAgentInterface[];
     getDataComponents(): DataComponentApiInsert[];
     getArtifactComponents(): ArtifactComponentApiInsert[];
+    setContext(tenantId: string, projectId: string): void;
     addTool(name: string, tool: any): void;
     addTransfer(...agents: AgentInterface[]): void;
     addDelegate(...agents: AgentInterface[]): void;
@@ -387,6 +421,7 @@ interface ExternalAgentInterface {
     getBaseUrl(): string;
     getCredentialReferenceId(): string | undefined;
     getHeaders(): Record<string, string> | undefined;
+    setContext?(tenantId: string): void;
 }
 interface GraphInterface {
     init(): Promise<void>;
@@ -435,6 +470,7 @@ declare class Agent implements AgentInterface {
     private projectId;
     private initialized;
     constructor(config: AgentConfig);
+    setContext(tenantId: string, projectId: string): void;
     getId(): string;
     getName(): string;
     getInstructions(): string;
@@ -467,56 +503,6 @@ declare class Agent implements AgentInterface {
     private createAgentToolRelation;
 }
 
-interface ArtifactComponentInterface {
-    config: Omit<ArtifactComponentInsert, 'id'>;
-    init(): Promise<void>;
-    getId(): ArtifactComponentInsert['id'];
-    getName(): ArtifactComponentInsert['name'];
-    getDescription(): ArtifactComponentInsert['description'];
-    getSummaryProps(): ArtifactComponentInsert['summaryProps'];
-    getFullProps(): ArtifactComponentInsert['fullProps'];
-}
-declare class ArtifactComponent implements ArtifactComponentInterface {
-    config: ArtifactComponentInsert;
-    private baseURL;
-    private tenantId;
-    private projectId;
-    private initialized;
-    private id;
-    constructor(config: Omit<ArtifactComponentInsert, 'id'>);
-    getId(): string;
-    getName(): string;
-    getDescription(): string;
-    getSummaryProps(): ArtifactComponentInsert['summaryProps'];
-    getFullProps(): ArtifactComponentInsert['fullProps'];
-    init(): Promise<void>;
-    private upsertArtifactComponent;
-}
-
-interface DataComponentInterface {
-    config: Omit<DataComponentInsert, 'id'>;
-    init(): Promise<void>;
-    getId(): DataComponentInsert['id'];
-    getName(): DataComponentInsert['name'];
-    getDescription(): DataComponentInsert['description'];
-    getProps(): DataComponentInsert['props'];
-}
-declare class DataComponent implements DataComponentInterface {
-    config: DataComponentInsert;
-    private baseURL;
-    private tenantId;
-    private projectId;
-    private initialized;
-    private id;
-    constructor(config: Omit<DataComponentInsert, 'id'>);
-    getId(): string;
-    getName(): string;
-    getDescription(): string;
-    getProps(): DataComponentInsert['props'];
-    init(): Promise<void>;
-    private upsertDataComponent;
-}
-
 declare class AgentGraph implements GraphInterface {
     private agents;
     private agentMap;
@@ -713,7 +699,6 @@ interface ProjectConfig {
     id: string;
     name: string;
     description?: string;
-    tenantId?: string;
     models?: {
         base?: ModelSettings;
         structuredOutput?: ModelSettings;
@@ -721,6 +706,9 @@ interface ProjectConfig {
     };
     stopWhen?: StopWhen;
     graphs?: () => AgentGraph[];
+    tools?: () => Tool[];
+    dataComponents?: () => DataComponent[];
+    artifactComponents?: () => ArtifactComponent[];
 }
 /**
  * Project interface for operations
@@ -833,6 +821,17 @@ declare class Project implements ProjectInterface {
      * Set the project's stopWhen configuration
      */
     setStopWhen(stopWhen: ProjectConfig['stopWhen']): void;
+    /**
+     * Get credential tracking information
+     */
+    getCredentialTracking(): Promise<{
+        credentials: Record<string, any>;
+        usage: Record<string, Array<{
+            type: string;
+            id: string;
+            graphId?: string;
+        }>>;
+    }>;
     /**
      * Get all graphs in the project
      */
@@ -869,10 +868,6 @@ declare class Project implements ProjectInterface {
      * Convert the Project to FullProjectDefinition format
      */
     private toFullProjectDefinition;
-    /**
-     * Convert project configuration to API format
-     */
-    private toApiFormat;
 }
 
 /**
@@ -1065,6 +1060,56 @@ declare function artifactComponent(config: ArtifactComponentConfig): ArtifactCom
 declare function dataComponent(config: DataComponentConfig): DataComponent;
 declare function agentMcp(config: AgentMcpConfig): AgentMcpConfig;
 
+/**
+ * Credential Reference System
+ *
+ * This module provides a way to reference credentials by ID without including
+ * the full credential definition in the code. Credentials are resolved from
+ * environment files at runtime during the push operation.
+ */
+/**
+ * Represents a reference to a credential by its ID.
+ * The actual credential will be resolved from the environment file at push time.
+ */
+interface CredentialReference {
+    __type: 'credential-ref';
+    id: string;
+}
+/**
+ * Create a reference to a credential by its ID.
+ * The credential must be defined in the environment files.
+ *
+ * @param id - The ID of the credential to reference
+ * @returns A credential reference that will be resolved at push time
+ *
+ * @example
+ * ```typescript
+ * const apiKeyRef = credentialRef('api-key');
+ *
+ * const fetchDef = fetchDefinition({
+ *   credential: apiKeyRef,
+ *   // ...
+ * });
+ * ```
+ */
+declare function credentialRef<T extends string = string>(id: T): CredentialReference;
+/**
+ * Type guard to check if a value is a credential reference
+ */
+declare function isCredentialReference(value: any): value is CredentialReference;
+/**
+ * Type helper to extract credential IDs from environment configuration
+ */
+type ExtractCredentialIds<T> = T extends {
+    credentials?: infer C;
+} ? C extends Record<string, any> ? keyof C : never : never;
+/**
+ * Type helper to create a union of all available credential IDs from multiple environments
+ */
+type UnionCredentialIds<T extends Record<string, any>> = {
+    [K in keyof T]: ExtractCredentialIds<T[K]>;
+}[keyof T];
+
 interface EnvironmentSettingsConfig {
     credentials?: {
         [settingId: string]: CredentialReferenceApiInsert;
@@ -1074,7 +1119,7 @@ interface EnvironmentSettingsConfig {
  * Create a setting helper with TypeScript autocomplete
  */
 declare function createEnvironmentSettings<T extends Record<string, EnvironmentSettingsConfig>>(environments: T): {
-    getEnvironmentSetting: (key: keyof NonNullable<T[keyof T]["credentials"]>) => Promise<CredentialReferenceApiInsert>;
+    getEnvironmentSetting: (key: UnionCredentialIds<T>) => CredentialReferenceApiInsert;
 };
 /**
  * Create type-safe environment configurations
@@ -1140,4 +1185,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, 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 };
+export { Agent, type AgentCanUseType, type AgentConfig, AgentError, type AgentInterface, type AgentResponse, type AllAgentInterface, ArtifactComponent, type ArtifactComponentInterface, type AssistantMessage, type BuilderAgentConfig, type BuilderRelationConfig, type BuilderToolConfig, type CredentialReference, DataComponent, type DataComponentInterface, ExternalAgent, type ExternalAgentInterface, type ExtractCredentialIds, 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 StreamEvent, type StreamResponse, type SystemMessage, Tool, type ToolCall, type ToolConfig, ToolExecutionError, type ToolMessage, type ToolResult, type TransferConfig, TransferError, type UnionCredentialIds, type UserMessage, agent, agentGraph, agentMcp, artifactComponent, createEnvironmentSettings, createFullProjectViaAPI, credential, credentialRef, dataComponent, deleteFullProjectViaAPI, externalAgent, externalAgents, getFullProjectViaAPI, isCredentialReference, mcpServer, mcpTool, project, raceGraphs, registerEnvironmentSettings, run, stream, transfer, updateFullProjectViaAPI };