qlogicagent 2.2.0 → 2.4.0

package/dist/types/protocol/notifications.d.ts

@@ -2,499 +2,8 @@
  * Centralized Notification Event Protocol — all JSON-RPC notification types
  * that qlogicagent emits to external apps.
  *
- * This is the SINGLE SOURCE OF TRUTH for the agent's outbound event contract.
- * Frontend, Electron, Hub, and test harness all consume these types.
- *
- * Reference: Codex app-server events, Claude Code streaming events,
- *            DeerFlow LangGraph stream modes.
- */
-import type { TokenUsage } from "../agent/types.js";
-import type { TodoItem } from "../contracts/todo.js";
-import type { AgentSource } from "../runtime/infra/acp-types.js";
-/** Embedded thread item for clients using the Thread protocol. */
-export interface NotificationThreadItem {
-    id: string;
-    type: string;
-    role: "user" | "assistant" | "system";
-    text?: string;
-    toolName?: string;
-    toolCallId?: string;
-    arguments?: string;
-    output?: string;
-    approved?: boolean;
-    strategy?: string;
-    createdAt: string;
-}
-/** Turn started — always emitted first. */
-export interface TurnStartNotification {
-    turnId: string;
-    /** Model being used for this turn (Codex parity). */
-    model?: string;
-    /** Provider id. */
-    provider?: string;
-}
-/** Streaming text chunk from the main agent. */
-export interface TurnDeltaNotification {
-    turnId: string;
-    text: string;
-    item?: NotificationThreadItem;
-    agentSource?: AgentSource;
-}
-/** Turn completed successfully. */
-export interface TurnEndNotification {
-    turnId: string;
-    content: string;
-    usage?: TokenUsage;
-    model?: string;
-    provider?: string;
-    item?: NotificationThreadItem;
-    agentSource?: AgentSource;
-}
-/** Turn failed. */
-export interface TurnErrorNotification {
-    turnId: string;
-    error: string;
-    code?: string;
-}
-/** Agent self-recovered from an error (retry, conversation repair, etc.). */
-export interface TurnRecoveryNotification {
-    turnId: string;
-    action: string;
-    detail?: string;
-    item?: NotificationThreadItem;
-}
-/** Tool invocation started — includes arguments for UI display. */
-export interface TurnToolCallNotification {
-    turnId: string;
-    callId: string;
-    name: string;
-    /** Serialized arguments JSON. Enables UI to display "searching for X", "reading file Y". */
-    arguments?: string;
-    item?: NotificationThreadItem;
-    agentSource?: AgentSource;
-}
-/**
- * Tool execution completed.
- * Includes truncated output for "Used X sources" style panels.
- */
-export interface TurnToolResultNotification {
-    turnId: string;
-    callId: string;
-    name: string;
-    ok: boolean;
-    error?: string;
-    /** Truncated tool output (max 2000 chars). Enables source preview panels. */
-    outputPreview?: string;
-    item?: NotificationThreadItem;
-}
-/** Tool execution blocked by permission system. */
-export interface TurnToolBlockedNotification {
-    turnId: string;
-    callId: string;
-    name: string;
-    reason: string;
-    item?: NotificationThreadItem;
-}
-/**
- * Reasoning/thinking token stream — separate from main delta.
- * Enables DeerFlow-style collapsible thinking blocks.
- *
- * For models that support extended thinking (Claude, DeepSeek-R1, o1),
- * reasoning content is streamed via this event instead of turn.delta.
+ * CANONICAL SOURCE: protocol/wire/notification-payloads.ts
+ * This file re-exports the wire types.
+ * Internal consumers import from this file — zero churn.
  */
-export interface TurnReasoningDeltaNotification {
-    turnId: string;
-    text: string;
-}
-/** Plan/strategy update — rendered as DeerFlow Plan component. */
-export interface TurnPlanUpdateNotification {
-    turnId: string;
-    slug: string;
-    content: string;
-    item?: NotificationThreadItem;
-}
-/** Suggestion items — interactive quick-action buttons. */
-export interface TurnSuggestionsNotification {
-    turnId: string;
-    items: Array<{
-        text: string;
-        icon?: string;
-        action?: string;
-    }>;
-}
-/** Sub-agent (fork, skill, dream) started execution. */
-export interface TurnSubagentStartedNotification {
-    turnId: string;
-    subagentId: string;
-    agentType: string;
-    prompt?: string;
-}
-/** Sub-agent streaming text chunk. */
-export interface TurnSubagentDeltaNotification {
-    agentType: string;
-    subagentId?: string;
-    text: string;
-}
-/** Sub-agent completed execution. */
-export interface TurnSubagentEndedNotification {
-    turnId: string;
-    subagentId: string;
-    agentType: string;
-    ok: boolean;
-    /** Truncated result (max 2000 chars). */
-    outputPreview?: string;
-    error?: string;
-}
-/** URL citations / file citations returned by OpenAI built-in tools. */
-export interface TurnAnnotationsNotification {
-    turnId: string;
-    annotations: Array<{
-        type: string;
-        url?: string;
-        title?: string;
-        [key: string]: unknown;
-    }>;
-}
-export type MediaResultType = "image" | "tts" | "video" | "music" | "3d";
-/** Structured media generation result — enables media preview cards. */
-export interface TurnMediaResultNotification {
-    turnId: string;
-    mediaType: MediaResultType;
-    /** Local file path or URL. */
-    url: string;
-    /** Model used for generation. */
-    model?: string;
-    /** Provider id. */
-    provider?: string;
-    /** Duration in seconds (for TTS/video). */
-    durationSeconds?: number;
-    /** Image dimensions. */
-    width?: number;
-    height?: number;
-    /** MIME type (e.g. "audio/mpeg", "image/png"). */
-    mimeType?: string;
-    /** Billing info. */
-    billingUnit?: string;
-    billingQuantity?: number;
-    /** Backend task ID — for progress querying / cancellation. */
-    taskId?: string;
-}
-/** Async media generation progress — emitted during polling for video/music/3D tasks. */
-export interface TurnMediaProgressNotification {
-    turnId: string;
-    /** Backend task ID (provider-specific). */
-    taskId: string;
-    mediaType: MediaResultType;
-    /** Estimated progress (0-100). */
-    percent: number;
-    /** Provider status label (e.g. "queuing", "running", "processing"). */
-    status: string;
-    /** Provider id. */
-    provider?: string;
-}
-/** Media files auto-downloaded to local storage (~/.qlogicagent/media/). */
-export interface TurnMediaPersistedNotification {
-    turnId: string;
-    files: Array<{
-        remoteUrl: string;
-        localPath: string;
-        bytes: number;
-        mimeType: string;
-    }>;
-}
-/** Full todo list updated — enables DeerFlow-style todo panel sync. */
-export interface TurnTodosUpdatedNotification {
-    turnId?: string;
-    items: TodoItem[];
-    summary: {
-        total: number;
-        completed: number;
-        inProgress: number;
-        notStarted: number;
-    };
-}
-/** Infrastructure task state change (bash, agent fork, dream). */
-export interface TaskUpdatedNotification {
-    taskId: string;
-    type: string;
-    lifecycle: string;
-    label?: string;
-}
-/** Long-running command execution progress (shell, script). */
-export interface TurnExecProgressNotification {
-    output: string;
-    elapsedTimeSeconds: number;
-    totalLines: number;
-    totalBytes: number;
-}
-/** Generic progress heartbeat (e.g. builtin tool status). */
-export interface TurnHeartbeatNotification {
-    turnId: string;
-    message: string;
-}
-/** Human-readable summary of a tool use batch. */
-export interface TurnToolUseSummaryNotification {
-    turnId: string;
-    summary: string;
-}
-export type ArtifactType = "code" | "file" | "image" | "document" | "diagram" | "table";
-/** Structured artifact produced by the agent — enables Canvas-style rendering. */
-export interface TurnArtifactNotification {
-    turnId: string;
-    artifactId: string;
-    type: ArtifactType;
-    title: string;
-    /** File path (for file/code artifacts). */
-    filePath?: string;
-    /** Language id (for code artifacts). */
-    language?: string;
-    /** Content body (may be truncated for large artifacts). */
-    content?: string;
-    /** MIME type. */
-    mimeType?: string;
-}
-/** Agent requests user approval before executing a restricted tool. */
-export interface ToolApprovalRequestNotification {
-    approvalId: string;
-    callId: string;
-    toolName: string;
-    arguments: string;
-    message?: string;
-    suggestions?: string[];
-}
-/** Skill instruction directive. */
-export interface TurnSkillInstructionNotification {
-    turnId: string;
-    instruction: unknown;
-}
-/** Agent asks the user a clarifying question mid-turn. Host presents UI, then responds via thread.user_response. */
-export interface TurnAskUserNotification {
-    requestId: string;
-    questions: Array<{
-        header: string;
-        question: string;
-        options?: Array<{
-            label: string;
-            description?: string;
-        }>;
-    }>;
-}
-/** Memory content changed (local md or QMemory). */
-export interface MemoryUpdatedNotification {
-    source: string;
-    /** Memory target (memory, user, etc.). */
-    target?: string;
-    /** Number of entries. */
-    entryCount?: number;
-    /** Human-readable summary of what changed. */
-    summary?: string;
-}
-/** Emitted when importance decay runs after a Dream consolidation. */
-export interface MemoryDecayCompletedNotification {
-    /** Number of memories whose importance was reduced. */
-    decayed: number;
-    /** Number of memories archived (below threshold). */
-    archived: number;
-    /** Duration in ms. */
-    durationMs: number;
-}
-/** Session metadata changed (title, model, etc.). */
-export interface SessionInfoNotification {
-    sessionId: string;
-    title?: string;
-    model?: string;
-    provider?: string;
-    cwd?: string;
-    turnCount?: number;
-}
-/** Permission rule saved/updated. */
-export interface PermissionRuleUpdatedNotification {
-    /** Tool name glob pattern. */
-    pattern: string;
-    /** New permission behavior (allow, deny, ask). */
-    behavior: string;
-}
-/** Team created, updated, or destroyed. */
-export interface TeamUpdatedNotification {
-    teamName: string;
-    action: "created" | "destroyed" | "member_joined" | "member_left";
-    members?: Array<{
-        agentName: string;
-        role: string;
-        worktreePath?: string;
-        pid?: number;
-    }>;
-}
-/** Forwarded notification from a team member child process. */
-export interface TeamMemberNotification {
-    memberId: string;
-    method: string;
-    params: unknown;
-}
-/** Team member child process state change. */
-export interface TeamMemberStateNotification {
-    memberId: string;
-    state: "starting" | "ready" | "running" | "completed" | "failed" | "killed";
-}
-export interface PongNotification {
-}
-/** Real-time token usage update (emitted after each LLM call within a turn). */
-export interface TurnUsageUpdateNotification {
-    turnId: string;
-    usage: TokenUsage;
-    model?: string;
-    /** Cumulative cost estimate for this session (USD). */
-    sessionCostUSD?: number;
-}
-/** Agent status change notification. */
-export interface AgentsStatusNotification {
-    agentId: string;
-    status: "available" | "spawning" | "running" | "hang" | "failed" | "unavailable";
-    health?: {
-        missedBeats: number;
-        lastActiveAt: string;
-    };
-    usage?: {
-        inputTokens: number;
-        outputTokens: number;
-        totalTokens: number;
-    };
-    error?: {
-        phase: string;
-        message: string;
-        retriesLeft: number;
-    };
-}
-/** Agent error notification. */
-export interface AgentsErrorNotification {
-    agentId: string;
-    phase: "detect" | "spawn" | "handshake" | "runtime" | "shutdown" | "heartbeat";
-    error: string;
-    retriesLeft: number;
-}
-/** Solo agent progress notification. */
-export interface SoloProgressNotification {
-    soloId: string;
-    agentId: string;
-    state: "pending" | "running" | "completed" | "failed";
-    progress?: string;
-}
-/** Solo evaluation completed notification. */
-export interface SoloEvaluationNotification {
-    soloId: string;
-    winnerId: string;
-    reasoning: string;
-}
-/** Solo agent streaming delta — text output from a competing agent. */
-export interface SoloAgentDeltaNotification {
-    soloId: string;
-    agentId: string;
-    text: string;
-}
-/** Product task started. */
-export interface ProductTaskStartedNotification {
-    productId: string;
-    taskId: string;
-    assignee: string;
-}
-/** Product task completed. */
-export interface ProductTaskCompletedNotification {
-    productId: string;
-    taskId: string;
-    result: string;
-}
-/** Product task failed. */
-export interface ProductTaskFailedNotification {
-    productId: string;
-    taskId: string;
-    error: string;
-}
-/** Product checkpoint saved. */
-export interface ProductCheckpointedNotification {
-    productId: string;
-    timestamp: string;
-}
-/** Product budget warning (>80%). */
-export interface ProductBudgetWarningNotification {
-    productId: string;
-    usedTokens: number;
-    maxTotalTokens: number;
-    percentage: number;
-}
-/** Product completed (all tasks done or terminal). */
-export interface ProductCompletedNotification {
-    productId: string;
-    summary: string;
-}
-/** A project was created. */
-export interface ProjectCreatedNotification {
-    id: string;
-    name: string;
-    workspaceDir: string;
-    type: string;
-    groupId?: string;
-}
-/** Active project was switched. */
-export interface ProjectSwitchedNotification {
-    id: string;
-    name: string;
-    workspaceDir: string;
-}
-/** A project was deleted. */
-export interface ProjectDeletedNotification {
-    id: string;
-}
-export interface NotificationMethodMap {
-    "turn.start": TurnStartNotification;
-    "turn.delta": TurnDeltaNotification;
-    "turn.end": TurnEndNotification;
-    "turn.error": TurnErrorNotification;
-    "turn.recovery": TurnRecoveryNotification;
-    "turn.tool_call": TurnToolCallNotification;
-    "turn.tool_result": TurnToolResultNotification;
-    "turn.tool_blocked": TurnToolBlockedNotification;
-    "turn.reasoning_delta": TurnReasoningDeltaNotification;
-    "turn.plan_update": TurnPlanUpdateNotification;
-    "turn.suggestions": TurnSuggestionsNotification;
-    "turn.subagent_started": TurnSubagentStartedNotification;
-    "turn.subagent_delta": TurnSubagentDeltaNotification;
-    "turn.subagent_ended": TurnSubagentEndedNotification;
-    "turn.annotations": TurnAnnotationsNotification;
-    "turn.media_result": TurnMediaResultNotification;
-    "turn.media_progress": TurnMediaProgressNotification;
-    "turn.media_persisted": TurnMediaPersistedNotification;
-    "turn.todos_updated": TurnTodosUpdatedNotification;
-    "task.updated": TaskUpdatedNotification;
-    "turn.exec_progress": TurnExecProgressNotification;
-    "turn.heartbeat": TurnHeartbeatNotification;
-    "turn.tool_use_summary": TurnToolUseSummaryNotification;
-    "turn.artifact": TurnArtifactNotification;
-    "tool.approval.request": ToolApprovalRequestNotification;
-    "turn.skill_instruction": TurnSkillInstructionNotification;
-    "turn.ask_user": TurnAskUserNotification;
-    "memory.updated": MemoryUpdatedNotification;
-    "memory.decay.completed": MemoryDecayCompletedNotification;
-    "session.info": SessionInfoNotification;
-    "permission.rule_updated": PermissionRuleUpdatedNotification;
-    "team.updated": TeamUpdatedNotification;
-    "team.member.notification": TeamMemberNotification;
-    "team.member.state": TeamMemberStateNotification;
-    "turn.usage_update": TurnUsageUpdateNotification;
-    "pong": PongNotification;
-    "agents.status": AgentsStatusNotification;
-    "agents.error": AgentsErrorNotification;
-    "solo.progress": SoloProgressNotification;
-    "solo.evaluation": SoloEvaluationNotification;
-    "solo.agentDelta": SoloAgentDeltaNotification;
-    "product.taskStarted": ProductTaskStartedNotification;
-    "product.taskCompleted": ProductTaskCompletedNotification;
-    "product.taskFailed": ProductTaskFailedNotification;
-    "product.checkpointed": ProductCheckpointedNotification;
-    "product.budgetWarning": ProductBudgetWarningNotification;
-    "product.completed": ProductCompletedNotification;
-    "project.created": ProjectCreatedNotification;
-    "project.switched": ProjectSwitchedNotification;
-    "project.deleted": ProjectDeletedNotification;
-}
-/** All known notification method names. */
-export type NotificationMethod = keyof NotificationMethodMap;
+export type { AgentSource, AgentsErrorNotification, AgentsStatusNotification, ArtifactType, MediaResultType, MemoryDecayCompletedNotification, MemoryUpdatedNotification, NotificationMethod, NotificationMethodMap, NotificationThreadItem, PermissionRuleUpdatedNotification, PlanInterruptedNotification, PongNotification, ProductBudgetUpdateNotification, ProductBudgetWarningNotification, ProductCheckpointedNotification, ProductCompletedNotification, ProductDagTopologyNotification, ProductTaskCompletedNotification, ProductTaskFailedNotification, ProductTaskOutputDeltaNotification, ProductTaskStartedNotification, ProjectArchivedNotification, ProjectCreatedNotification, ProjectDeletedNotification, ProjectRenamedNotification, ProjectSwitchedNotification, ProjectUnarchivedNotification, SessionInfoNotification, SoloAgentDeltaNotification, SoloAgentDiffNotification, SoloAgentUsageNotification, SoloEvaluationNotification, SoloProgressNotification, TeamMemberNotification, ToolApprovalRequestNotification, TurnAnnotationsNotification, TurnArtifactNotification, TurnAskUserNotification, TurnDeltaNotification, TurnEndNotification, TurnErrorNotification, TurnExecProgressNotification, TurnHeartbeatNotification, TurnMediaPersistedNotification, TurnMediaProgressNotification, TurnMediaResultNotification, TurnPlanUpdateNotification, TurnReasoningDeltaNotification, TurnRecoveryNotification, TurnSidechainCompletedNotification, TurnSidechainStartedNotification, TurnSkillInstructionNotification, TurnStartNotification, TurnSubagentDeltaNotification, TurnSuggestionsNotification, TurnTaskUpdatedNotification, TurnTodosUpdatedNotification, TurnToolBlockedNotification, TurnToolCallNotification, TurnToolResultNotification, TurnToolUseSummaryNotification, TurnUsageUpdateNotification, WireTokenUsage, } from "./wire/index.js";