@hilbras/omninode 0.8.0 → 0.9.0

package/dist/index.d.ts

@@ -291,6 +291,8 @@ interface PipelineStepRun {
     status: TaskStatus;
     /** Tasks created for this step (research fans out to several). */
     taskIds?: string[];
+    /** Set on plan steps that produced a stored plan (§18). */
+    planId?: string;
     error?: string;
 }
 interface PipelineRun {
@@ -304,6 +306,38 @@ interface PipelineRun {
     reports?: Report[];
     /** Set when the report system generated a combined report for this run. */
     combinedReportId?: string;
+    /** Set when a plan step produced an implementation plan (§18). */
+    planId?: string;
+}
+
+/** Plan types: the final implementation plan produced by the planner layer (§18). */
+interface PlanStep {
+    id: string;
+    title: string;
+    description?: string;
+    order: number;
+    /** Files/modules the step touches, if stated. */
+    targets?: string[];
+    acceptanceCriteria?: string[];
+    /** Plan-internal dependencies between steps. */
+    dependsOn?: string[];
+    /** Finding ids that motivated this step (traceability to reports). */
+    sourceFindings?: string[];
+}
+interface Plan {
+    id: string;
+    objective: string;
+    summary: string;
+    steps: PlanStep[];
+    risks?: string[];
+    notes?: string[];
+    /** What produced the plan, e.g. "model:my-gateway:chatgpt" or "heuristic". */
+    generatedBy: string;
+    model?: string;
+    taskId?: string;
+    pipelineRunId?: string;
+    createdAt: string;
+    metadata?: Record<string, unknown>;
 }
 
 /** Agent ↔ OmniNode communication protocol (§21). */
@@ -452,7 +486,7 @@ interface IChatProvider extends IProvider {
 }
 
 /** Typed error hierarchy shared across the whole codebase (§4.1 — error model). */
-type OmniNodeErrorCode = "CONFIG_NOT_FOUND" | "CONFIG_INVALID" | "PROVIDER_NOT_FOUND" | "PROVIDER_UNAVAILABLE" | "PROVIDER_AUTH_FAILED" | "MODEL_NOT_FOUND" | "AGENT_NOT_FOUND" | "AGENT_FAILED" | "AGENT_TIMEOUT" | "TASK_INVALID" | "TASK_NOT_FOUND" | "TASK_FAILED" | "PIPELINE_NOT_FOUND" | "PIPELINE_INVALID" | "PIPELINE_FAILED" | "PROTOCOL_VIOLATION" | "MEMORY_UNAVAILABLE" | "REPORT_NOT_FOUND" | "NOT_IMPLEMENTED" | "CLI_USAGE" | "INTERNAL";
+type OmniNodeErrorCode = "CONFIG_NOT_FOUND" | "CONFIG_INVALID" | "PROVIDER_NOT_FOUND" | "PROVIDER_UNAVAILABLE" | "PROVIDER_AUTH_FAILED" | "MODEL_NOT_FOUND" | "AGENT_NOT_FOUND" | "AGENT_FAILED" | "AGENT_TIMEOUT" | "TASK_INVALID" | "TASK_NOT_FOUND" | "TASK_FAILED" | "PIPELINE_NOT_FOUND" | "PIPELINE_INVALID" | "PIPELINE_FAILED" | "PLANNER_FAILED" | "PLAN_INVALID" | "PROTOCOL_VIOLATION" | "MEMORY_UNAVAILABLE" | "REPORT_NOT_FOUND" | "NOT_IMPLEMENTED" | "CLI_USAGE" | "INTERNAL";
 interface OmniNodeErrorOptions {
     cause?: unknown;
     details?: Record<string, unknown>;
@@ -480,6 +514,9 @@ declare class PipelineError extends OmniNodeError {
 declare class ProtocolError extends OmniNodeError {
     constructor(message: string, options?: OmniNodeErrorOptions);
 }
+declare class PlannerError extends OmniNodeError {
+    constructor(code: "PLANNER_FAILED" | "PLAN_INVALID", message: string, options?: OmniNodeErrorOptions);
+}
 declare class MemoryError extends OmniNodeError {
     constructor(message: string, options?: OmniNodeErrorOptions);
 }
@@ -702,6 +739,19 @@ declare const pipelineConfigSchema: z.ZodObject<{
     name?: string | undefined;
     objective?: string | undefined;
 }>;
+declare const plannerConfigSchema: z.ZodObject<{
+    kind: z.ZodDefault<z.ZodEnum<["model", "heuristic"]>>;
+    model: z.ZodOptional<z.ZodString>;
+    instruction: z.ZodOptional<z.ZodString>;
+}, "strict", z.ZodTypeAny, {
+    kind: "model" | "heuristic";
+    model?: string | undefined;
+    instruction?: string | undefined;
+}, {
+    kind?: "model" | "heuristic" | undefined;
+    model?: string | undefined;
+    instruction?: string | undefined;
+}>;
 declare const projectConfigSchema: z.ZodObject<{
     name: z.ZodString;
     providers: z.ZodDefault<z.ZodArray<z.ZodObject<{
@@ -853,6 +903,19 @@ declare const projectConfigSchema: z.ZodObject<{
         name?: string | undefined;
         objective?: string | undefined;
     }>, "many">>;
+    planner: z.ZodOptional<z.ZodObject<{
+        kind: z.ZodDefault<z.ZodEnum<["model", "heuristic"]>>;
+        model: z.ZodOptional<z.ZodString>;
+        instruction: z.ZodOptional<z.ZodString>;
+    }, "strict", z.ZodTypeAny, {
+        kind: "model" | "heuristic";
+        model?: string | undefined;
+        instruction?: string | undefined;
+    }, {
+        kind?: "model" | "heuristic" | undefined;
+        model?: string | undefined;
+        instruction?: string | undefined;
+    }>>;
     memory: z.ZodOptional<z.ZodObject<{
         provider: z.ZodDefault<z.ZodString>;
         base_url: z.ZodOptional<z.ZodString>;
@@ -914,6 +977,11 @@ declare const projectConfigSchema: z.ZodObject<{
         name?: string | undefined;
         objective?: string | undefined;
     }[];
+    planner?: {
+        kind: "model" | "heuristic";
+        model?: string | undefined;
+        instruction?: string | undefined;
+    } | undefined;
     memory?: {
         provider: string;
         base_url?: string | undefined;
@@ -967,6 +1035,11 @@ declare const projectConfigSchema: z.ZodObject<{
         name?: string | undefined;
         objective?: string | undefined;
     }[] | undefined;
+    planner?: {
+        kind?: "model" | "heuristic" | undefined;
+        model?: string | undefined;
+        instruction?: string | undefined;
+    } | undefined;
     memory?: {
         base_url?: string | undefined;
         api_key_env_var?: string | undefined;
@@ -1125,6 +1198,19 @@ declare const appConfigSchema: z.ZodObject<{
             name?: string | undefined;
             objective?: string | undefined;
         }>, "many">>;
+        planner: z.ZodOptional<z.ZodObject<{
+            kind: z.ZodDefault<z.ZodEnum<["model", "heuristic"]>>;
+            model: z.ZodOptional<z.ZodString>;
+            instruction: z.ZodOptional<z.ZodString>;
+        }, "strict", z.ZodTypeAny, {
+            kind: "model" | "heuristic";
+            model?: string | undefined;
+            instruction?: string | undefined;
+        }, {
+            kind?: "model" | "heuristic" | undefined;
+            model?: string | undefined;
+            instruction?: string | undefined;
+        }>>;
         memory: z.ZodOptional<z.ZodObject<{
             provider: z.ZodDefault<z.ZodString>;
             base_url: z.ZodOptional<z.ZodString>;
@@ -1186,6 +1272,11 @@ declare const appConfigSchema: z.ZodObject<{
             name?: string | undefined;
             objective?: string | undefined;
         }[];
+        planner?: {
+            kind: "model" | "heuristic";
+            model?: string | undefined;
+            instruction?: string | undefined;
+        } | undefined;
         memory?: {
             provider: string;
             base_url?: string | undefined;
@@ -1239,6 +1330,11 @@ declare const appConfigSchema: z.ZodObject<{
             name?: string | undefined;
             objective?: string | undefined;
         }[] | undefined;
+        planner?: {
+            kind?: "model" | "heuristic" | undefined;
+            model?: string | undefined;
+            instruction?: string | undefined;
+        } | undefined;
         memory?: {
             base_url?: string | undefined;
             api_key_env_var?: string | undefined;
@@ -1301,6 +1397,11 @@ declare const appConfigSchema: z.ZodObject<{
             name?: string | undefined;
             objective?: string | undefined;
         }[];
+        planner?: {
+            kind: "model" | "heuristic";
+            model?: string | undefined;
+            instruction?: string | undefined;
+        } | undefined;
         memory?: {
             provider: string;
             base_url?: string | undefined;
@@ -1359,6 +1460,11 @@ declare const appConfigSchema: z.ZodObject<{
             name?: string | undefined;
             objective?: string | undefined;
         }[] | undefined;
+        planner?: {
+            kind?: "model" | "heuristic" | undefined;
+            model?: string | undefined;
+            instruction?: string | undefined;
+        } | undefined;
         memory?: {
             base_url?: string | undefined;
             api_key_env_var?: string | undefined;
@@ -1374,6 +1480,7 @@ type AgentConfigYaml = z.infer<typeof agentConfigSchema>;
 type RoleConfigYaml = z.infer<typeof roleConfigSchema>;
 type PipelineConfigYaml = z.infer<typeof pipelineConfigSchema>;
 type PipelineStepConfigYaml = z.infer<typeof pipelineStepConfigSchema>;
+type PlannerConfigYaml = z.infer<typeof plannerConfigSchema>;
 type ProjectConfigYaml = z.infer<typeof projectConfigSchema>;
 type AppConfigYaml = z.infer<typeof appConfigSchema>;
 
@@ -1384,6 +1491,11 @@ interface AppConfig {
         agents: AgentConfig[];
         roles: RoleDefinition[];
         pipelines: PipelineDefinition[];
+        planner?: {
+            kind: "model" | "heuristic";
+            model?: string;
+            instruction?: string;
+        };
         memory?: {
             provider: string;
             baseUrl?: string;
@@ -1730,6 +1842,35 @@ interface AggregateOptions {
 declare function aggregateReports(reports: Report[], options?: AggregateOptions): CombinedReport;
 declare function similar(a: string, b: string, threshold: number): boolean;
 
+/** Planner interface and request contract (§18). The planner is replaceable. */
+
+interface PlanRequest {
+    objective: string;
+    /** Raw reports (already normalized) the plan is based on. */
+    reports: Report[];
+    /** Combined research context from upstream pipeline steps, if available. */
+    context?: string;
+    role?: RoleDefinition;
+    memory?: MemoryEntry[];
+    project?: string;
+    taskId?: string;
+    pipelineRunId?: string;
+}
+interface IPlanner {
+    readonly name: string;
+    plan(request: PlanRequest): Promise<Plan>;
+}
+
+interface PlanFilter {
+    pipelineRunId?: string;
+    taskId?: string;
+}
+interface PlanStore {
+    save(plan: Plan): Promise<void>;
+    get(id: string): Promise<Plan | undefined>;
+    list(filter?: PlanFilter): Promise<Plan[]>;
+}
+
 interface PipelineRunFilter {
     pipelineId?: string;
     status?: PipelineRunStatus;
@@ -1759,6 +1900,10 @@ interface PipelineEngineOptions {
     providers: AppConfig["project"]["providers"];
     store: PipelineRunStore;
     chat?: ChatFn;
+    /** Default planner used by plan steps without their own model (§18). */
+    planner?: IPlanner;
+    /** When present, plans produced by plan steps are persisted. */
+    plans?: PlanStore;
     /** When present, finished runs have their reports collected, stored and combined (§16–§17). */
     reports?: ReportService;
     log?: Logger;
@@ -1797,10 +1942,8 @@ declare class PipelineEngine {
 /** Default chat function: resolves "provider:model" against the configured providers. */
 declare function createDefaultChatFn(providers: AppConfig["project"]["providers"]): ChatFn;
 
-/** Assembles a PipelineEngine from the project configuration (local-first defaults). */
-
 declare function buildPipelineEngine(config: AppConfig, log?: Logger): PipelineEngine;
 
-declare const OMNINODE_VERSION = "0.8.0";
+declare const OMNINODE_VERSION = "0.9.0";
 
-export { type AgentConfig, type AgentConfigYaml, 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 ChatFn, type ChatMessage, type ChatRequest, type ChatResponse, type ChatRole, type ChatUsage, type CombinedMeta, type CombinedReport, type CombinedReportFilter, type Confidence, ConfigError, ConsoleLogSink, type CreateTaskInput, type DiscoveryResult, type EnvelopeMeta, type ExtractionMeta, FilePipelineRunStore, FileReportStore, FileTaskStore, type Finding, type FindingSeverity, type FindingSource, type HttpRequestOptions, type HttpResponse, type IAgent, type IChatProvider, type IMemoryProvider, type IProvider, type LoadConfigOptions, LocalMemoryProvider, type LogLevel, type LogSink, Logger, type LoggerOptions, type MemoryContextQuery, type MemoryEntry, MemoryError, type MemoryProviderConfig, type MemoryQuery, type MemoryScope, MemoryService, type MessageEnvelope, type ModelCapabilities, type ModelFilter, type ModelInfo, ModelRegistry, type ModelStatus, type NodeToAgentMessage, OMNINODE_VERSION, OPENAI_COMPATIBLE_TYPES, type OmniHilbrasConnectionResult, OmniHilbrasProvider, OmniNodeError, type OmniNodeErrorCode, type OmniNodeErrorOptions, OpenAICompatibleProvider, 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, ProcessAgent, type Project, type ProjectConfigYaml, ProtocolError, type ProviderConfig, type ProviderConfigYaml, ProviderError, type ProviderHealth, type ProviderStatus, type ProviderType, type RememberaConfig, RememberaMemoryProvider, type Report, type ReportFilter, ReportService, type ReportStore, type RoleConfigYaml, type RoleDefinition, RoleRegistry, type RunPipelineOptions, type Task, type TaskContext, TaskEngine, type TaskEngineOptions, TaskError, type TaskResult, type TaskStatus, type TaskStore, type TaskStoreFilter, type WritableLike, agentConfigSchema, aggregateReports, appConfigSchema, authHeaders, buildAgentRegistry, buildPipelineEngine, buildRoleRegistry, composeTaskText, createAgent, createDefaultChatFn, createMemoryProvider, createProvider, createTaskEngine, defaultProjectConfigYaml, expandEnvRefs, extractReportFromText, findConfigFile, isOmniNodeError, keywords, loadConfig, logger, pipelineConfigSchema, pipelineStepConfigSchema, projectConfigSchema, providerConfigSchema, registryKey, requestJson, resolveApiKey, roleConfigSchema, similar };
+export { type AgentConfig, type AgentConfigYaml, 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 ChatFn, type ChatMessage, type ChatRequest, type ChatResponse, type ChatRole, type ChatUsage, type CombinedMeta, type CombinedReport, type CombinedReportFilter, type Confidence, ConfigError, ConsoleLogSink, type CreateTaskInput, type DiscoveryResult, type EnvelopeMeta, type ExtractionMeta, FilePipelineRunStore, FileReportStore, FileTaskStore, type Finding, type FindingSeverity, type FindingSource, type HttpRequestOptions, type HttpResponse, type IAgent, type IChatProvider, type IMemoryProvider, type IProvider, type LoadConfigOptions, LocalMemoryProvider, type LogLevel, type LogSink, Logger, type LoggerOptions, type MemoryContextQuery, type MemoryEntry, MemoryError, type MemoryProviderConfig, type MemoryQuery, type MemoryScope, MemoryService, type MessageEnvelope, type ModelCapabilities, type ModelFilter, type ModelInfo, ModelRegistry, type ModelStatus, type NodeToAgentMessage, OMNINODE_VERSION, OPENAI_COMPATIBLE_TYPES, type OmniHilbrasConnectionResult, OmniHilbrasProvider, OmniNodeError, type OmniNodeErrorCode, type OmniNodeErrorOptions, OpenAICompatibleProvider, 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 PlanStep, type PlannerConfigYaml, PlannerError, ProcessAgent, type Project, type ProjectConfigYaml, ProtocolError, type ProviderConfig, type ProviderConfigYaml, ProviderError, type ProviderHealth, type ProviderStatus, type ProviderType, type RememberaConfig, RememberaMemoryProvider, type Report, type ReportFilter, ReportService, type ReportStore, type RoleConfigYaml, type RoleDefinition, RoleRegistry, type RunPipelineOptions, type Task, type TaskContext, TaskEngine, type TaskEngineOptions, TaskError, type TaskResult, type TaskStatus, type TaskStore, type TaskStoreFilter, type WritableLike, agentConfigSchema, aggregateReports, appConfigSchema, authHeaders, buildAgentRegistry, buildPipelineEngine, buildRoleRegistry, composeTaskText, createAgent, createDefaultChatFn, createMemoryProvider, createProvider, createTaskEngine, defaultProjectConfigYaml, expandEnvRefs, extractReportFromText, findConfigFile, isOmniNodeError, keywords, loadConfig, logger, pipelineConfigSchema, pipelineStepConfigSchema, plannerConfigSchema, projectConfigSchema, providerConfigSchema, registryKey, requestJson, resolveApiKey, roleConfigSchema, similar };