@moda-ai/cli 1.22.1 → 1.23.0

package/dist/output.d.ts

@@ -1,191 +0,0 @@
-import { type AgentAuthRequest, type AgentInputRequest } from './errors.js';
-export type CliOutputMode = 'human' | 'json' | 'agent' | 'agent-stream';
-export declare const AGENT_SCHEMA_VERSION = "moda.agent.v1";
-export declare const AGENT_EVENT_SCHEMA_VERSION = "moda.agent_event.v1";
-/**
- * One-line feedback nudge stamped into every non-feedback success envelope's
- * `meta.tip` (agents are the CLI's most common callers, and the envelope is
- * where they actually look). Deliberately conditional wording so agents flag
- * genuine observations instead of habitually running the command. The
- * human-TTY twin is printed on stderr by the dispatcher in cli.ts.
- */
-export declare const FEEDBACK_TIP = "Help us improve! If a result in this response looks wrong or is missing data, flag it: moda feedback \"<describe what looked wrong>\" [--category=...] [--conversation-id=... | --cluster-id=... | --tool-name=...]. Only submit genuine observations.";
-/**
- * Stable process exit codes that an external agent can branch on:
- *   0  ok        — grounded answer from Moda Cloud intelligence.
- *   3  degraded  — answer produced from a local/degraded fallback (lower trust).
- *   1  error     — command/input/unexpected failure (see envelope `errors[]`).
- *   4  auth      — login or token renewal required before retrying.
- *   5  input     — non-interactive caller must choose and re-invoke.
- *   130 cancel   — interrupted or the output consumer closed the pipe.
- * `EXIT_DEGRADED` is intentionally distinct so a caller can tell a degraded
- * answer apart from both success and hard failure without parsing the payload.
- */
-export declare const EXIT_OK = 0;
-export declare const EXIT_ERROR = 1;
-export declare const EXIT_DEGRADED = 3;
-export declare const EXIT_AUTH_REQUIRED = 4;
-export declare const EXIT_INPUT_REQUIRED = 5;
-export declare const EXIT_CANCELLED = 130;
-export declare const AGENT_ERROR_CODES: readonly ["input_error", "api_error", "network_error", "auth_required", "input_required", "cancelled", "command_error", "access_denied", "unknown_error", "cloud_unavailable"];
-export type AgentErrorCode = typeof AGENT_ERROR_CODES[number];
-export type AgentStatus = 'ok' | 'degraded' | 'error';
-export type AgentConfidence = 'high' | 'medium' | 'low' | 'unknown';
-export interface AgentSummary {
-    text: string;
-    confidence: AgentConfidence;
-}
-export interface AgentFinding {
-    id: string;
-    title: string;
-    status?: string;
-    severity?: string;
-    description?: string;
-    evidence_ref_ids?: string[];
-}
-export interface AgentEvidenceRef {
-    id: string;
-    kind: string;
-    label: string;
-    path?: string;
-    line?: number;
-    status?: string;
-    /** Root-relative dashboard deep-link (prefix the Moda base URL to open). */
-    href?: string;
-}
-export interface AgentRecommendedAction {
-    id: string;
-    title: string;
-    rationale?: string;
-    command?: string;
-    mutability: 'read' | 'write' | 'sync' | 'unknown';
-    requires_approval: boolean;
-}
-export interface AgentNextCommand {
-    command: string;
-    purpose: string;
-    mutability: 'read' | 'write' | 'sync' | 'unknown';
-    requires_approval: boolean;
-}
-export interface AgentArtifact {
-    kind: string;
-    path: string;
-    description?: string;
-}
-export interface AgentError {
-    code: AgentErrorCode | string;
-    message: string;
-    cause?: string;
-    suggested_commands?: string[];
-    input_request?: AgentInputRequest;
-    auth?: AgentAuthRequest;
-    blocking: boolean;
-}
-export interface AgentEnvelope {
-    schema_version: typeof AGENT_SCHEMA_VERSION;
-    command: string;
-    status: AgentStatus;
-    generated_at: string;
-    profile?: string;
-    summary: AgentSummary;
-    findings: AgentFinding[];
-    evidence_refs: AgentEvidenceRef[];
-    recommended_actions: AgentRecommendedAction[];
-    next_commands: AgentNextCommand[];
-    artifacts: AgentArtifact[];
-    warnings: string[];
-    errors: AgentError[];
-    data: unknown;
-    meta?: Record<string, unknown>;
-    truncation?: Record<string, unknown>;
-}
-export interface AgentEvent {
-    schema_version: typeof AGENT_EVENT_SCHEMA_VERSION;
-    event: 'started' | 'progress' | 'artifact' | 'approval_required' | 'completed' | 'error' | 'heartbeat' | 'needs_input' | 'auth_required' | 'cancelled' | 'warning';
-    command: string;
-    generated_at: string;
-    run_id?: string;
-    seq?: number;
-    event_version?: number;
-    status?: AgentStatus;
-    phase?: string;
-    message?: string;
-    elapsed_ms?: number;
-    artifact?: AgentArtifact;
-    result?: AgentEnvelope;
-    error?: AgentError;
-    input_request?: AgentInputRequest;
-    auth?: AgentAuthRequest;
-}
-export interface AgentWriteOptions {
-    summary?: string | Partial<AgentSummary>;
-    findings?: AgentFinding[];
-    evidenceRefs?: AgentEvidenceRef[];
-    recommendedActions?: AgentRecommendedAction[];
-    nextCommands?: Array<string | AgentNextCommand>;
-    artifacts?: AgentArtifact[];
-    warnings?: string[];
-    errors?: AgentError[];
-}
-export interface CliOutput {
-    mode: CliOutputMode;
-    quiet: boolean;
-    writeData(data: unknown, options?: {
-        status?: 'success' | 'degraded' | 'error';
-        meta?: Record<string, unknown>;
-    } & AgentWriteOptions): void;
-    writeEvent(event: Omit<AgentEvent, 'schema_version' | 'command' | 'generated_at'>): void;
-    writeError(error: unknown): void;
-    writeCancelled(reason?: string): void;
-    hasTerminalOutput(): boolean;
-    close(): void;
-}
-interface OutputRunState {
-    runId: string;
-    seq: number;
-    started: boolean;
-    terminal: boolean;
-    startedAt: number;
-    lastEventAt: number;
-    heartbeat?: NodeJS.Timeout;
-}
-/**
- * True once an EPIPE from a closed stdout/stderr consumer has been observed.
- * The stream error listeners above own this state; expose it so callers can
- * detect consumer-cancelled runs explicitly instead of sniffing the global
- * `process.exitCode`.
- */
-export declare function wasOutputCancelled(): boolean;
-export declare function safeWriteStdout(text: string): boolean;
-export declare function safeWriteStderr(text: string): boolean;
-/** Flag-only resolution (default human). Kept for callers that only have flags. */
-export declare function outputModeFromFlags(flags: Record<string, string>): CliOutputMode;
-/**
- * Resolve the effective output mode for a real CLI invocation, in priority
- * order: explicit flags -> `MODA_FORMAT` -> agent-environment detection ->
- * TTY detection (piped/redirected => agent JSON) -> human prose. This is what
- * makes the CLI agent-safe: a piped/automated caller gets structured output
- * with zero flags, while a human at a terminal still gets prose.
- */
-export declare function resolveOutputMode(flags: Record<string, string>, opts?: {
-    isTTY?: boolean;
-    env?: NodeJS.ProcessEnv;
-}): CliOutputMode;
-export declare function createCliOutput(options: {
-    command: string;
-    mode: CliOutputMode;
-    quiet?: boolean;
-    runId?: string;
-}): CliOutput;
-export declare function createAgentEnvelope(options: {
-    command: string;
-    status: AgentStatus;
-    data: unknown;
-    profile?: string;
-    meta?: Record<string, unknown>;
-} & AgentWriteOptions): AgentEnvelope;
-export declare function createAgentErrorEnvelope(command: string, error: AgentError, runId?: string): AgentEnvelope;
-export declare function createAgentEvent(command: string, event: Omit<AgentEvent, 'schema_version' | 'command' | 'generated_at' | 'run_id' | 'seq'>, state?: OutputRunState): AgentEvent;
-export declare function errorToAgentError(error: unknown): AgentError;
-export {};
-//# sourceMappingURL=output.d.ts.map