@distri/core 0.3.5 → 0.3.6

package/dist/index.d.mts

@@ -7,6 +7,7 @@ interface RunStartedEvent {
     data: {
         runId?: string;
         taskId?: string;
+        agentId?: string;
     };
 }
 interface RunFinishedEvent {
@@ -368,6 +369,12 @@ declare class DistriClient {
      * Get specific agent by ID
      */
     getAgent(agentId: string): Promise<AgentConfigWithTools>;
+    /**
+     * Fetch all available models grouped by provider, with configuration status.
+     * Each provider includes `configured: boolean` indicating whether the
+     * provider's required API key(s) are set on the server.
+     */
+    fetchAvailableModels(): Promise<ProviderModelsStatus[]>;
     /**
      * Update an agent's definition (markdown only)
      */
@@ -489,6 +496,8 @@ declare class DistriClient {
      * Enhanced fetch with retry logic and auth headers.
      * Exposed publicly for extensions like DistriHomeClient.
      */
+    /** Call a registered tool via the server's /tools/call endpoint. */
+    callTool(toolName: string, input: Record<string, unknown>): Promise<unknown>;
     fetch(input: RequestInfo | URL, initialInit?: RequestInit): Promise<Response>;
     /**
      * Delay utility
@@ -824,6 +833,45 @@ interface DynamicMetadata {
      *  Parts not listed will use default metadata (save: true). */
     parts?: Record<number, PartMetadata>;
 }
+/**
+ * Tier of context compaction applied by the server.
+ */
+type CompactionTier = 'trim' | 'summarize' | 'reset';
+/**
+ * Emitted when the agent performs context compaction to stay within
+ * token budget limits. Mirrors the server-side ContextCompaction event.
+ */
+interface ContextCompactionEvent {
+    type: 'context_compaction';
+    /** Which tier of compaction was applied */
+    tier: CompactionTier;
+    /** Token count before compaction */
+    tokens_before: number;
+    /** Token count after compaction */
+    tokens_after: number;
+    /** Number of entries removed or summarized */
+    entries_affected: number;
+    /** Context budget limit that triggered compaction */
+    context_limit: number;
+    /** Usage ratio that triggered compaction (0.0 - 1.0) */
+    usage_ratio: number;
+    /** Optional summary text (for Tier 2 summarization) */
+    summary?: string;
+}
+/**
+ * Current context health information derived from compaction events
+ * and usage tracking.
+ */
+interface ContextHealth {
+    /** Current usage ratio (0.0 - 1.0) */
+    usage_ratio: number;
+    /** Estimated tokens currently used */
+    tokens_used: number;
+    /** Token budget limit */
+    tokens_limit: number;
+    /** Last compaction event, if any */
+    last_compaction?: ContextCompactionEvent;
+}
 /**
  * Context required for constructing A2A messages from DistriMessage
  */
@@ -1021,9 +1069,9 @@ interface McpDefinition {
     type?: McpServerType;
 }
 interface ModelSettings {
-    model: string;
+    model?: string;
     temperature: number;
-    max_tokens: number;
+    max_tokens?: number;
     context_size: number;
     top_p: number;
     frequency_penalty: number;
@@ -1063,6 +1111,9 @@ interface DistriThread {
     user_id?: string;
     external_id?: string;
     tags?: string[];
+    input_tokens?: number;
+    output_tokens?: number;
+    total_tokens?: number;
 }
 interface Thread {
     id: string;
@@ -1074,7 +1125,11 @@ interface Thread {
     last_message?: string;
     user_id?: string;
     external_id?: string;
+    channel_id?: string;
     tags?: string[];
+    input_tokens?: number;
+    output_tokens?: number;
+    total_tokens?: number;
 }
 /**
  * Parameters for listing threads with filtering and pagination
@@ -1203,11 +1258,16 @@ interface DistriClientConfig {
      */
     workspaceId?: string;
 }
+interface TokenUsage {
+    input_tokens: number;
+    output_tokens: number;
+    total_tokens: number;
+}
 interface LLMResponse {
     finish_reason: string;
     content: string;
     tool_calls: ToolCall[];
-    token_usage: number;
+    usage?: TokenUsage;
     tools?: any[];
 }
 interface ExternalMcpServer {
@@ -1311,6 +1371,40 @@ interface MessageVoteSummary {
     /** Current user's vote on this message, if any */
     user_vote?: VoteType;
 }
+/**
+ * Information about a single model
+ */
+interface ModelInfo {
+    id: string;
+    name: string;
+}
+/**
+ * Models grouped by provider with configuration status
+ */
+interface ProviderModelsStatus {
+    provider_id: string;
+    provider_label: string;
+    configured: boolean;
+    models: ModelInfo[];
+}
+interface UsageHistoryEntry {
+    date: string;
+    tokens: number;
+    identifier_id?: string | null;
+    channel_id?: string | null;
+    channel_name?: string | null;
+    agent_id?: string | null;
+}
+interface ChannelUsageSummary {
+    id: string;
+    name: string | null;
+    provider: string;
+}
+interface UsageHistoryFilters {
+    identifier_id?: string;
+    channel_id?: string;
+    agent_id?: string;
+}
 
 /**
  * Converts an A2A Message to a DistriMessage
@@ -1357,4 +1451,181 @@ declare function extractToolCallsFromDistriMessage(message: DistriMessage): any[
  */
 declare function extractToolResultsFromDistriMessage(message: DistriMessage): any[];
 
-export { A2AProtocolError, type A2AStreamEventData, type ActionPlanStep, Agent, type AgentConfigWithTools, type AgentDefinition, type AgentHandoverEvent, type AgentStats, type AgentUsageInfo, ApiError, type AssistantWithToolCalls, type BasePlanStep, type BatchToolCallsStep, type BrowserAgentConfig, type BrowserScreenshotEvent, type BrowserSession, type BrowserSessionStartedEvent, type ChatCompletionChoice, type ChatCompletionMessage, type ChatCompletionRequest, type ChatCompletionResponse, type ChatCompletionResponseFormat, type ChatCompletionRole, type ChatProps, type CodePlanStep, type ConfigurationMeta, type ConfigurationResponse, ConnectionError, type ConnectionStatus, DEFAULT_BASE_URL, type DataPart, type DistriBaseTool, type DistriBrowserRuntimeConfig, type DistriChatMessage, DistriClient, type DistriClientConfig, type DistriConfiguration, DistriError, type DistriEvent, type DistriFnTool, type DistriMessage, type DistriMessageMetadata, type DistriPart, type DistriPartWithMetadata, type DistriPlan, type DistriStreamEvent, type DistriThread, type DynamicMetadata, type ExternalMcpServer, ExternalToolValidationError, type ExternalToolValidationResult, type FeedbackReceivedEvent, type FileBytes, type FileType, type FileUrl, type FinalResultPlanStep, type HookContext, type HookHandler, type HookMutation, type ImagePart, type InlineHookEventData, type InlineHookRequest, type InlineHookRequestedEvent, type InvokeConfig, type InvokeContext, type InvokeResult, type LLMResponse, type LlmExecuteOptions, type LlmPlanStep, type McpDefinition, type McpServerType, type MessageReadStatus, type MessageRole, type MessageVote, type MessageVoteSummary, type ModelProviderConfig, type ModelProviderName, type ModelSettings, type PartMetadata, type PlanAction, type PlanFinishedEvent, type PlanPrunedEvent, type PlanStartedEvent, type PlanStep, type PromptSection, type ReactStep, type Role, type RunErrorEvent, type RunFinishedEvent, type RunStartedEvent, type ServerConfig, type SpeechToTextConfig, type StepCompletedEvent, type StepStartedEvent, type StreamingTranscriptionOptions, type TextMessageContentEvent, type TextMessageEndEvent, type TextMessageStartEvent, type TextPart, type ThoughtPlanStep, type ThoughtStep, type Thread, type ThreadListParams, type ThreadListResponse, type TodoItem, type TodoStatus, type TodosUpdatedEvent, type ToolCall, type ToolCallPart, type ToolCallsEvent, type ToolDefinition, type ToolExecutionEndEvent, type ToolExecutionOptions, type ToolExecutionStartEvent, type ToolHandler, type ToolRejectedEvent, type ToolResult, type ToolResultData, type ToolResultRefPart, type ToolResults, type ToolResultsEvent, type UseToolsOptions, type VoteMessageRequest, type VoteType, convertA2AMessageToDistri, convertA2APartToDistri, convertA2AStatusUpdateToDistri, convertDistriMessageToA2A, convertDistriPartToA2A, createFailedToolResult, createSuccessfulToolResult, decodeA2AStreamEvent, extractTextFromDistriMessage, extractToolCallsFromDistriMessage, extractToolResultData, extractToolResultsFromDistriMessage, isArrayParts, isDistriEvent, isDistriMessage, processA2AMessagesData, processA2AStreamData, uuidv4 };
+/**
+ * Workflow engine types — mirrors distri-workflow Rust crate.
+ */
+type WorkflowStatus = 'pending' | 'running' | 'paused' | 'completed' | 'failed' | 'blocked';
+type StepStatus = 'pending' | 'blocked' | 'running' | 'done' | 'failed' | 'skipped';
+type StepExecution = 'sequential' | 'parallel';
+interface WorkflowDefinition {
+    id: string;
+    workflow_type: string;
+    /** JSON Schema for required inputs. */
+    input_schema?: Record<string, unknown>;
+    steps: WorkflowStep[];
+    status?: WorkflowStatus;
+    current_step?: number;
+    context?: Record<string, unknown>;
+    notes?: WorkflowNote[];
+    created_at?: string;
+    updated_at?: string;
+}
+interface WorkflowStep {
+    id: string;
+    label: string;
+    kind: StepKind;
+    depends_on?: string[];
+    execution?: StepExecution;
+    requires?: StepRequirement[];
+    /** Explicit input mapping with {input.X}, {steps.X.Y}, {env.X} references. */
+    input?: Record<string, unknown>;
+    status?: StepStatus;
+    result?: unknown;
+    error?: string | null;
+    started_at?: string | null;
+    completed_at?: string | null;
+}
+interface StepRequirement {
+    skill: string;
+    permissions?: string[];
+    config?: unknown;
+}
+type StepKind = {
+    type: 'tool_call';
+    tool_name: string;
+    input?: unknown;
+    agent_id?: string;
+} | {
+    type: 'api_call';
+    method: string;
+    url: string;
+    body?: unknown;
+    headers?: Record<string, string>;
+} | {
+    type: 'script';
+    command: string;
+    args?: string[];
+    cwd?: string;
+    timeout_secs?: number;
+} | {
+    type: 'agent_run';
+    agent_id: string;
+    prompt: string;
+    tools?: string[];
+    skills?: string[];
+    model?: string;
+} | {
+    type: 'condition';
+    expression: string;
+    if_true: StepKind;
+    if_false?: StepKind;
+} | {
+    type: 'checkpoint';
+    message: string;
+};
+interface StepResult {
+    status: StepStatus;
+    result?: unknown;
+    error?: string | null;
+    context_updates?: Record<string, unknown>;
+}
+interface WorkflowNote {
+    step_id: string;
+    message: string;
+    at: string;
+}
+/** Helper: count steps by status */
+declare function countSteps(workflow: WorkflowDefinition): {
+    pending: number;
+    blocked: number;
+    running: number;
+    done: number;
+    failed: number;
+    skipped: number;
+};
+/** Helper: get progress percentage */
+declare function workflowProgress(workflow: WorkflowDefinition): number;
+/** Helper: get the step icon for display */
+declare function stepIcon(status: StepStatus): string;
+
+/**
+ * WorkflowRunner — client-side workflow execution engine.
+ *
+ * Mirrors the Rust DistriStepExecutor + WorkflowRunner.
+ * Runs workflow steps in dependency order, resolves namespace references,
+ * emits WorkflowEvent callbacks, and executes steps via DistriClient or custom handlers.
+ *
+ * Usage:
+ *   const runner = new WorkflowRunner(client, {
+ *     buildRequest: (step, init) => ({ ...init, headers: { ...init.headers, 'X-Custom': 'value' } })
+ *   })
+ *   const events = runner.run(workflowDef, { doc_id: 'abc' })
+ *   for await (const event of events) { console.log(event) }
+ */
+
+type WorkflowEvent = {
+    event: 'workflow_started';
+    workflow_id: string;
+    workflow_type: string;
+    total_steps: number;
+} | {
+    event: 'step_started';
+    workflow_id: string;
+    step_id: string;
+    step_label: string;
+} | {
+    event: 'step_completed';
+    workflow_id: string;
+    step_id: string;
+    step_label: string;
+    result?: unknown;
+} | {
+    event: 'step_failed';
+    workflow_id: string;
+    step_id: string;
+    step_label: string;
+    error: string;
+} | {
+    event: 'workflow_completed';
+    workflow_id: string;
+    status: WorkflowStatus;
+    steps_done: number;
+    steps_failed: number;
+};
+type WorkflowEventCallback = (event: WorkflowEvent) => void;
+interface WorkflowRunnerOptions {
+    /** Hook to customize fetch RequestInit before HTTP calls (add auth, base URL, etc.) */
+    buildRequest?: (step: WorkflowStep, init: RequestInit, url: string) => {
+        url: string;
+        init: RequestInit;
+    };
+    /** Environment variables injected into {env.X} namespace */
+    env?: Record<string, unknown>;
+    /** Custom step executor — override default behavior for any step kind */
+    executeStep?: (step: WorkflowStep, resolvedInput: unknown, context: ExecutionContext) => Promise<StepResult>;
+}
+interface ExecutionContext {
+    input: Record<string, unknown>;
+    steps: Record<string, unknown>;
+    env: Record<string, unknown>;
+}
+/** Resolve {namespace.path} in a string template. */
+declare function resolveTemplate(template: string, ctx: ExecutionContext): string;
+/** Recursively resolve namespace references in a JSON value.
+ *  Full-value references like "{steps.fetch.items}" preserve the original type. */
+declare function resolveValue(value: unknown, ctx: ExecutionContext): unknown;
+declare class WorkflowRunner {
+    private client;
+    private options;
+    constructor(client: DistriClient, options?: WorkflowRunnerOptions);
+    /** Run a workflow to completion. Returns an async generator of WorkflowEvents. */
+    run(definition: WorkflowDefinition, input?: Record<string, unknown>): AsyncGenerator<WorkflowEvent>;
+    /** Find indices of steps that are pending with all dependencies met. */
+    private findRunnable;
+    /** Default step executor — handles tool_call, api_call, checkpoint, etc. */
+    private executeStep;
+    private executeToolCall;
+    private executeApiCall;
+}
+
+export { A2AProtocolError, type A2AStreamEventData, type ActionPlanStep, Agent, type AgentConfigWithTools, type AgentDefinition, type AgentHandoverEvent, type AgentStats, type AgentUsageInfo, ApiError, type AssistantWithToolCalls, type BasePlanStep, type BatchToolCallsStep, type BrowserAgentConfig, type BrowserScreenshotEvent, type BrowserSession, type BrowserSessionStartedEvent, type ChannelUsageSummary, type ChatCompletionChoice, type ChatCompletionMessage, type ChatCompletionRequest, type ChatCompletionResponse, type ChatCompletionResponseFormat, type ChatCompletionRole, type ChatProps, type CodePlanStep, type CompactionTier, type ConfigurationMeta, type ConfigurationResponse, ConnectionError, type ConnectionStatus, type ContextCompactionEvent, type ContextHealth, DEFAULT_BASE_URL, type DataPart, type DistriBaseTool, type DistriBrowserRuntimeConfig, type DistriChatMessage, DistriClient, type DistriClientConfig, type DistriConfiguration, DistriError, type DistriEvent, type DistriFnTool, type DistriMessage, type DistriMessageMetadata, type DistriPart, type DistriPartWithMetadata, type DistriPlan, type DistriStreamEvent, type DistriThread, type DynamicMetadata, type ExecutionContext, type ExternalMcpServer, ExternalToolValidationError, type ExternalToolValidationResult, type FeedbackReceivedEvent, type FileBytes, type FileType, type FileUrl, type FinalResultPlanStep, type HookContext, type HookHandler, type HookMutation, type ImagePart, type InlineHookEventData, type InlineHookRequest, type InlineHookRequestedEvent, type InvokeConfig, type InvokeContext, type InvokeResult, type LLMResponse, type LlmExecuteOptions, type LlmPlanStep, type McpDefinition, type McpServerType, type MessageReadStatus, type MessageRole, type MessageVote, type MessageVoteSummary, type ModelInfo, type ModelProviderConfig, type ModelProviderName, type ModelSettings, type PartMetadata, type PlanAction, type PlanFinishedEvent, type PlanPrunedEvent, type PlanStartedEvent, type PlanStep, type PromptSection, type ProviderModelsStatus, type ReactStep, type Role, type RunErrorEvent, type RunFinishedEvent, type RunStartedEvent, type ServerConfig, type SpeechToTextConfig, type StepCompletedEvent, type StepExecution, type StepKind, type StepRequirement, type StepResult, type StepStartedEvent, type StepStatus, type StreamingTranscriptionOptions, type TextMessageContentEvent, type TextMessageEndEvent, type TextMessageStartEvent, type TextPart, type ThoughtPlanStep, type ThoughtStep, type Thread, type ThreadListParams, type ThreadListResponse, type TodoItem, type TodoStatus, type TodosUpdatedEvent, type TokenUsage, type ToolCall, type ToolCallPart, type ToolCallsEvent, type ToolDefinition, type ToolExecutionEndEvent, type ToolExecutionOptions, type ToolExecutionStartEvent, type ToolHandler, type ToolRejectedEvent, type ToolResult, type ToolResultData, type ToolResultRefPart, type ToolResults, type ToolResultsEvent, type UsageHistoryEntry, type UsageHistoryFilters, type UseToolsOptions, type VoteMessageRequest, type VoteType, type WorkflowDefinition, type WorkflowEvent, type WorkflowEventCallback, type WorkflowNote, WorkflowRunner, type WorkflowRunnerOptions, type WorkflowStatus, type WorkflowStep, convertA2AMessageToDistri, convertA2APartToDistri, convertA2AStatusUpdateToDistri, convertDistriMessageToA2A, convertDistriPartToA2A, countSteps, createFailedToolResult, createSuccessfulToolResult, decodeA2AStreamEvent, extractTextFromDistriMessage, extractToolCallsFromDistriMessage, extractToolResultData, extractToolResultsFromDistriMessage, isArrayParts, isDistriEvent, isDistriMessage, processA2AMessagesData, processA2AStreamData, resolveTemplate, resolveValue, stepIcon, uuidv4, workflowProgress };