@hilbras/omninode 2.0.0-alpha.4 → 2.0.0-alpha.6

package/dist/index.d.ts

@@ -334,14 +334,25 @@ interface ModelCapabilities {
     embeddings?: boolean;
 }
 type ModelStatus = "available" | "unavailable" | "deprecated";
+type Modality = "text" | "image" | "audio" | "video" | "embedding";
+/** Model metadata (roadmap §10, Model Metadata). */
 interface ModelInfo {
     /** Name of the provider this model belongs to. */
     provider: string;
     /** Provider-specific model identifier, e.g. "qwen3-coder". */
     id: string;
     displayName?: string;
+    /** Human-readable model name reported by the provider, when available. */
+    name?: string;
     capabilities?: ModelCapabilities;
     contextWindow?: number;
+    inputTypes?: Modality[];
+    outputTypes?: Modality[];
+    supportsTools?: boolean;
+    supportsVision?: boolean;
+    supportsReasoning?: boolean;
+    supportsStructuredOutput?: boolean;
+    supportsStreaming?: boolean;
     status?: ModelStatus;
     metadata?: Record<string, unknown>;
 }
@@ -443,18 +454,37 @@ interface PipelineDefinition {
  * authoritative detail always lives in `stepRuns`/`taskRuns`.
  */
 type PipelineRunStatus = "pending" | "running" | "completed" | "failed" | "partial" | "cancelled";
+/**
+ * One step execution inside a run (§9.1 — Step Run is NOT the Step).
+ */
 interface PipelineStepRun {
     stepId: string;
     status: TaskStatus;
     /** Tasks created for this step (research fans out to several). */
     taskIds?: string[];
+    /** Execution ids of the tasks this step created, for correlation (§6.5). */
+    executionIds?: string[];
+    /** Which attempt of this step produced this record (1 = first try). */
+    attempt?: number;
     /** Set on plan steps that produced a stored plan (§18). */
     planId?: string;
     error?: string;
 }
+/** One execution attempt of a run (§9.1 — Attempt is not the Run). */
+interface PipelineRunAttempt {
+    attempt: number;
+    startedAt: string;
+    finishedAt?: string;
+    status: PipelineRunStatus;
+}
 interface PipelineRun {
     id: string;
     pipelineId: string;
+    /** Execution attempt counter: retries of the same run increment it. */
+    attempt: number;
+    /** Set when cancellation was requested; the run stops at the next check point. */
+    cancellationRequested?: boolean;
+    cancellationRequestedAt?: string;
     /** The objective this run is executing (persisted for retries). */
     objective?: string;
     status: PipelineRunStatus;
@@ -469,6 +499,28 @@ interface PipelineRun {
     planId?: string;
     /** Outcome summary of the final executed step (§28 — Result). */
     resultSummary?: string;
+    /** Per-attempt history (§9.1). */
+    attempts?: PipelineRunAttempt[];
+}
+/**
+ * Executor contract (roadmap §9.1 / §9.2): a Pipeline definition, a Run of
+ * it, Steps, Step Runs and Attempts are distinct concepts; this interface is
+ * what orchestration code depends on.
+ */
+interface IPipelineExecutor {
+    validate(definition: PipelineDefinition): void;
+    run(definition: PipelineDefinition, options?: PipelineRunOptions): Promise<PipelineRun>;
+    cancel(runId: string): Promise<void>;
+    get(runId: string): Promise<PipelineRun | undefined>;
+    listRuns(filter?: {
+        pipelineId?: string;
+    }): Promise<PipelineRun[]>;
+}
+interface PipelineRunOptions {
+    objective?: string;
+    onStep?: (stepRun: PipelineStepRun) => void;
+    /** Total run attempts (1 = no automatic rerun of the whole run). */
+    maxAttempts?: number;
 }
 
 /** Plan types: the final implementation plan produced by the planner layer (§18). */
@@ -609,7 +661,20 @@ interface Project {
 
 type ProviderType = "openai-compatible" | "omnihilbras" | "openrouter" | "local" | "custom";
 type ProviderHealth = "unknown" | "healthy" | "degraded" | "unreachable";
+/** Declared provider capabilities (roadmap §10, Provider Interface). */
+type ProviderCapability = "chat" | "models" | "streaming" | "tools" | "embeddings" | "vision";
+/** Normalized authentication description — never contains a secret value. */
+interface ProviderAuthentication {
+    /** How the provider authenticates. */
+    method: "bearer" | "none" | "custom";
+    /** Environment variable that holds the credential, if any. */
+    envVar?: string;
+    /** True when the referenced variable is currently set. */
+    configured: boolean;
+}
 interface ProviderConfig {
+    /** Stable identifier used in records and references (defaults to `name`). */
+    providerId?: string;
     /** Unique name used in project configuration and the model registry. */
     name: string;
     type: ProviderType;
@@ -620,6 +685,8 @@ interface ProviderConfig {
      */
     apiKeyEnvVar?: string;
     headers?: Record<string, string>;
+    /** Capabilities declared for this provider (discovered ones are merged in). */
+    capabilities?: ProviderCapability[];
     enabled?: boolean;
     metadata?: Record<string, unknown>;
 }
@@ -633,11 +700,22 @@ interface ProviderStatus {
     lastCheckedAt?: string;
     message?: string;
 }
-/** Contract every provider adapter implements (Phase 1+). */
+/** Contract every provider adapter implements (roadmap §10). */
 interface IProvider {
     readonly config: ProviderConfig;
+    /** Stable identifier of this provider. */
+    readonly providerId: string;
+    /** Normalized authentication description (no secret values). */
+    readonly authentication: ProviderAuthentication;
+    /**
+     * Connect: authenticate and discover models (roadmap §10, Model Discovery).
+     * Returns the discovered models.
+     */
+    connect(): Promise<ModelInfo[]>;
     /** Discover models exposed by this provider. */
     listModels(): Promise<ModelInfo[]>;
+    /** Fetch a single model's metadata (from discovery; re-discovers if unknown). */
+    getModel(modelId: string): Promise<ModelInfo | undefined>;
     /** Check connectivity and authentication. */
     healthCheck(): Promise<ProviderStatus>;
 }
@@ -1801,11 +1879,56 @@ declare function requestJson(url: string, options?: HttpRequestOptions): Promise
 declare const OPENAI_COMPATIBLE_TYPES: readonly ProviderType[];
 declare function createProvider(config: ProviderConfig): IChatProvider;
 
+/**
+ * Provider error normalization (roadmap §10).
+ *
+ * Every provider failure is mapped to one stable kind, so callers can react
+ * (retry a rate limit, surface an auth problem, treat a missing model
+ * differently) without string-matching provider-specific payloads.
+ */
+
+type ProviderErrorKind = "AUTHENTICATION_ERROR" | "RATE_LIMIT_ERROR" | "INVALID_REQUEST" | "MODEL_NOT_FOUND" | "TIMEOUT" | "NETWORK_ERROR" | "SERVER_ERROR" | "UNKNOWN_ERROR";
+interface ProviderErrorContext {
+    provider: string;
+    operation: string;
+    status?: number;
+    body?: unknown;
+    retryAfterMs?: number;
+    cause?: unknown;
+    /** Maps the normalized kind onto the legacy stable error code. */
+    code?: "PROVIDER_UNAVAILABLE" | "PROVIDER_AUTH_FAILED" | "MODEL_NOT_FOUND";
+}
+/** Kinds worth retrying automatically (rate limits and transient server errors). */
+declare function isRetryable(kind: ProviderErrorKind): boolean;
+/** Maps an HTTP status (and optional body) to a normalized kind. */
+declare function kindFromStatus(status: number): ProviderErrorKind;
+/** Extracts a human message from common provider error body shapes. */
+declare function extractMessage(body: unknown): string | undefined;
+/** Parses `Retry-After` (seconds or HTTP-date) into milliseconds. */
+declare function parseRetryAfter(value: string | null | undefined, now?: number): number | undefined;
+/** True for the abort/timeout errors raised by fetch's AbortSignal.timeout. */
+declare function isTimeoutError(error: unknown): boolean;
+/** True for transport failures (DNS, refused, TLS, offline). */
+declare function isNetworkError(error: unknown): boolean;
+declare function providerHttpError(context: ProviderErrorContext): ProviderError;
+/** Wraps a thrown transport/abort error into a normalized ProviderError. */
+declare function providerTransportError(context: Omit<ProviderErrorContext, "status" | "body">): ProviderError;
+
 declare class OpenAICompatibleProvider implements IChatProvider {
     readonly config: ProviderConfig;
+    readonly providerId: string;
+    readonly authentication: ProviderAuthentication;
     private readonly log;
-    constructor(config: ProviderConfig, log?: Logger);
+    /** Discovered models, so getModel() answers without another round-trip. */
+    private discovered?;
+    private readonly env;
+    constructor(config: ProviderConfig, log?: Logger, env?: Record<string, string | undefined>);
+    /** Authenticate + discover (roadmap §10, Model Discovery). */
+    connect(): Promise<ModelInfo[]>;
+    getModel(modelId: string): Promise<ModelInfo | undefined>;
     listModels(): Promise<ModelInfo[]>;
+    /** Maps a raw model entry onto the normalized metadata shape (§10). */
+    private toModelInfo;
     healthCheck(): Promise<ProviderStatus>;
     chat(request: ChatRequest): Promise<ChatResponse>;
 }
@@ -1852,7 +1975,7 @@ declare class OmniHilbrasProvider extends OpenAICompatibleProvider {
      * Run the full connect flow. Throws on authentication or transport failure
      * (use healthCheck() for a non-throwing probe).
      */
-    connect(registry?: ModelRegistry): Promise<OmniHilbrasConnectionResult>;
+    connectAndRegister(registry?: ModelRegistry): Promise<OmniHilbrasConnectionResult>;
 }
 
 /**
@@ -2458,11 +2581,19 @@ interface RunPipelineOptions {
     objective?: string;
     onStep?: (stepRun: PipelineStepRun) => void;
 }
-declare class PipelineEngine {
+declare class PipelineEngine implements IPipelineExecutor {
     private readonly options;
     private readonly log;
+    /** Runs executing in THIS process — cancellation can terminate them directly. */
+    private readonly activeRuns;
     constructor(options: PipelineEngineOptions);
     get store(): PipelineRunStore;
+    /**
+     * Saves the run while preserving fields that may be set by another process
+     * (e.g. a cancellation request) — an in-memory snapshot must never clobber
+     * externally requested cancellation (§9.2).
+     */
+    private persist;
     /** Structural + semantic validation (§27 Phase 5 — pipeline parser). */
     validate(def: PipelineDefinition): void;
     private assertAcyclic;
@@ -2471,13 +2602,18 @@ declare class PipelineEngine {
      * dependencies, which enable parallel branches.
      */
     private effectiveDependencies;
-    run(def: PipelineDefinition, options?: RunPipelineOptions): Promise<PipelineRun>;
+    run(def: PipelineDefinition, options?: PipelineRunOptions): Promise<PipelineRun>;
+    /** First-class cancellation (§9.2): requests cancellation and terminates
+     *  tasks that are running in this process immediately. */
+    cancel(runId: string): Promise<void>;
     get(runId: string): Promise<PipelineRun | undefined>;
     listRuns(filter?: {
         pipelineId?: string;
     }): Promise<PipelineRun[]>;
     private shouldRun;
     private executeStep;
+    /** Registers tasks created for a step as live, so cancellation can terminate them (§9.2). */
+    private trackLiveTasks;
     private executeStepOnce;
     /** Research fan-out: one task per agent, in parallel (§15). */
     private runFanOut;
@@ -2509,6 +2645,6 @@ declare class ProjectStores {
     constructor(directory?: string);
 }
 
-declare const OMNINODE_VERSION = "2.0.0-alpha.4";
+declare const OMNINODE_VERSION = "2.0.0-alpha.6";
 
-export { AgentAdapterRegistry, type AgentConfig, type AgentConfigYaml, type AgentDescriptor, AgentError, type AgentInfo, type AgentInputMode, type AgentIntegrationType, AgentRegistry, type AgentStatus, type AgentTaskInput, type AgentTaskOutput, type AgentToNodeMessage, type AggregateOptions, type AggregatedFinding, type AggregatedRecommendation, type AppConfig, type AppConfigYaml, type ArtifactKind, type ArtifactPayload, type AskedQuestion, type AuditAction, type AuditEvent, type AuditSink, type ChatFn, type ChatMessage, type ChatRequest, type ChatResponse, type ChatRole, type ChatUsage, type CombinedMeta, type CombinedReport, type CombinedReportFilter, type Confidence, ConfigError, ConsoleLogSink, type CreateTaskInput, type CwdValidation, DEFAULT_MAX_OUTPUT_BYTES, type DecodeResult, type DiscoveryResult, type EnvPolicy, type EnvelopeMeta, type ExecutionRecord, type ExtractionMeta, FileAuditLog, FilePipelineRunStore, FilePlanStore, FileReportStore, FileTaskStore, type Finding, type FindingSeverity, type FindingSource, type HelloResult, HeuristicPlanner, type HttpRequestOptions, type HttpResponse, type IAgent, type IAgentAdapter, type IChatProvider, type IMemoryProvider, type IPlanner, type IProvider, type JsonDocument, JsonFileStore, type JsonFileStoreOptions, type LoadConfigOptions, LocalMemoryProvider, type LogLevel, type LogSink, Logger, type LoggerOptions, MAX_MESSAGE_BYTES, type MemoryContextQuery, type MemoryEntry, MemoryError, type MemoryProviderConfig, type MemoryQuery, type MemoryScope, MemoryService, type MessageEnvelope, type ModelCapabilities, type ModelFilter, type ModelInfo, ModelPlanner, ModelRegistry, type ModelStatus, type NodeToAgentMessage, OMNINODE_VERSION, OPENAI_COMPATIBLE_TYPES, type OmniHilbrasConnectionResult, OmniHilbrasProvider, OmniNodeError, type OmniNodeErrorCode, type OmniNodeErrorOptions, OpenAICompatibleProvider, PROTOCOL_V2, type PipelineConfigYaml, type PipelineDefinition, PipelineEngine, type PipelineEngineOptions, PipelineError, type PipelineRun, type PipelineRunFilter, type PipelineRunStatus, type PipelineRunStore, type PipelineStep, type PipelineStepCondition, type PipelineStepConfigYaml, type PipelineStepKind, type PipelineStepRun, type Plan, type PlanFilter, type PlanRequest, type PlanStep, type PlanStore, type PlannerConfigYaml, PlannerError, ProcessAgent, ProcessAgentAdapter, type Project, type ProjectConfigYaml, ProjectStores, type ProtocolAgentToNodeType, ProtocolDecoder, type ProtocolEnvelope, ProtocolError, type ProtocolMessageType, type ProtocolNodeToAgentType, ProtocolSession, type ProtocolViolation, type ProtocolViolationCode, type ProviderConfig, type ProviderConfigYaml, ProviderError, type ProviderHealth, type ProviderStatus, type ProviderType, type QuestionPayload, type QuestionResponder, type RememberaConfig, RememberaMemoryProvider, type Report, type ReportFilter, type ReportPayload, ReportService, type ReportStore, type RoleConfigYaml, type RoleDefinition, RoleRegistry, type RunPipelineOptions, SUPPORTED_PROTOCOL_VERSIONS, type SessionIds, TERMINAL_TASK_STATUSES, type Task, type TaskContext, TaskEngine, type TaskEngineOptions, TaskError, type TaskPayload, type TaskResult, type TaskStatus, type TaskStore, type TaskStoreFilter, type WritableLike, agentConfigSchema, aggregateReports, appConfigSchema, authHeaders, buildAgentRegistry, buildChildEnv, buildHello, buildHelloAck, buildPipelineEngine, buildPlanner, buildPlannerContext, buildRoleRegistry, composeTaskText, createAgent, createDefaultChatFn, createMemoryProvider, createProvider, createTaskEngine, decodeMessage, decodeStream, defaultProjectConfigYaml, describeExit, encodeMessage, envelope, expandEnvRefs, extractReportFromText, findConfigFile, isOmniNodeError, isSupportedProtocol, keywords, killTree, loadConfig, logger, newMessageId, parseHello, parsePlanJson, pipelineConfigSchema, pipelineStepConfigSchema, plannerConfigSchema, projectConfigSchema, providerConfigSchema, registryKey, requestJson, requireCompletion, resolveApiKey, resolveEnvPolicy, roleConfigSchema, sanitizeChunk, similar, validateEnvelope, validateWorkingDirectory };
+export { AgentAdapterRegistry, type AgentConfig, type AgentConfigYaml, type AgentDescriptor, AgentError, type AgentInfo, type AgentInputMode, type AgentIntegrationType, AgentRegistry, type AgentStatus, type AgentTaskInput, type AgentTaskOutput, type AgentToNodeMessage, type AggregateOptions, type AggregatedFinding, type AggregatedRecommendation, type AppConfig, type AppConfigYaml, type ArtifactKind, type ArtifactPayload, type AskedQuestion, type AuditAction, type AuditEvent, type AuditSink, type ChatFn, type ChatMessage, type ChatRequest, type ChatResponse, type ChatRole, type ChatUsage, type CombinedMeta, type CombinedReport, type CombinedReportFilter, type Confidence, ConfigError, ConsoleLogSink, type CreateTaskInput, type CwdValidation, DEFAULT_MAX_OUTPUT_BYTES, type DecodeResult, type DiscoveryResult, type EnvPolicy, type EnvelopeMeta, type ExecutionRecord, type ExtractionMeta, FileAuditLog, FilePipelineRunStore, FilePlanStore, FileReportStore, FileTaskStore, type Finding, type FindingSeverity, type FindingSource, type HelloResult, HeuristicPlanner, type HttpRequestOptions, type HttpResponse, type IAgent, type IAgentAdapter, type IChatProvider, type IMemoryProvider, type IPipelineExecutor, type IPlanner, type IProvider, type JsonDocument, JsonFileStore, type JsonFileStoreOptions, type LoadConfigOptions, LocalMemoryProvider, type LogLevel, type LogSink, Logger, type LoggerOptions, MAX_MESSAGE_BYTES, type MemoryContextQuery, type MemoryEntry, MemoryError, type MemoryProviderConfig, type MemoryQuery, type MemoryScope, MemoryService, type MessageEnvelope, type Modality, type ModelCapabilities, type ModelFilter, type ModelInfo, ModelPlanner, ModelRegistry, type ModelStatus, type NodeToAgentMessage, OMNINODE_VERSION, OPENAI_COMPATIBLE_TYPES, type OmniHilbrasConnectionResult, OmniHilbrasProvider, OmniNodeError, type OmniNodeErrorCode, type OmniNodeErrorOptions, OpenAICompatibleProvider, PROTOCOL_V2, type PipelineConfigYaml, type PipelineDefinition, PipelineEngine, type PipelineEngineOptions, PipelineError, type PipelineRun, type PipelineRunAttempt, type PipelineRunFilter, type PipelineRunOptions, type PipelineRunStatus, type PipelineRunStore, type PipelineStep, type PipelineStepCondition, type PipelineStepConfigYaml, type PipelineStepKind, type PipelineStepRun, type Plan, type PlanFilter, type PlanRequest, type PlanStep, type PlanStore, type PlannerConfigYaml, PlannerError, ProcessAgent, ProcessAgentAdapter, type Project, type ProjectConfigYaml, ProjectStores, type ProtocolAgentToNodeType, ProtocolDecoder, type ProtocolEnvelope, ProtocolError, type ProtocolMessageType, type ProtocolNodeToAgentType, ProtocolSession, type ProtocolViolation, type ProtocolViolationCode, type ProviderAuthentication, type ProviderCapability, type ProviderConfig, type ProviderConfigYaml, ProviderError, type ProviderErrorKind, type ProviderHealth, type ProviderStatus, type ProviderType, type QuestionPayload, type QuestionResponder, type RememberaConfig, RememberaMemoryProvider, type Report, type ReportFilter, type ReportPayload, ReportService, type ReportStore, type RoleConfigYaml, type RoleDefinition, RoleRegistry, type RunPipelineOptions, SUPPORTED_PROTOCOL_VERSIONS, type SessionIds, TERMINAL_TASK_STATUSES, type Task, type TaskContext, TaskEngine, type TaskEngineOptions, TaskError, type TaskPayload, type TaskResult, type TaskStatus, type TaskStore, type TaskStoreFilter, type WritableLike, agentConfigSchema, aggregateReports, appConfigSchema, authHeaders, buildAgentRegistry, buildChildEnv, buildHello, buildHelloAck, buildPipelineEngine, buildPlanner, buildPlannerContext, buildRoleRegistry, composeTaskText, createAgent, createDefaultChatFn, createMemoryProvider, createProvider, createTaskEngine, decodeMessage, decodeStream, defaultProjectConfigYaml, describeExit, encodeMessage, envelope, expandEnvRefs, extractMessage, extractReportFromText, findConfigFile, isNetworkError, isOmniNodeError, isRetryable, isSupportedProtocol, isTimeoutError, keywords, killTree, kindFromStatus, loadConfig, logger, newMessageId, parseHello, parsePlanJson, parseRetryAfter, pipelineConfigSchema, pipelineStepConfigSchema, plannerConfigSchema, projectConfigSchema, providerConfigSchema, providerHttpError, providerTransportError, registryKey, requestJson, requireCompletion, resolveApiKey, resolveEnvPolicy, roleConfigSchema, sanitizeChunk, similar, validateEnvelope, validateWorkingDirectory };