@frost1994/agentic-core 1.0.0 → 1.0.3

package/dist/index.d.ts

@@ -8,6 +8,16 @@ export declare interface ActionDescriptor {
     riskLevel: 'safe' | 'caution' | 'danger';
 }
 
+/** A write-action pending 二次确认. */
+export declare interface ActionPart {
+    kind: 'action';
+    actionId: string;
+    title: string;
+    summary?: string;
+    riskLevel: RiskLevel;
+    params: Record<string, string | number | boolean | null>;
+}
+
 export declare interface AiAssistantError extends Error {
     code: ErrorCode;
     retriable: boolean;
@@ -49,6 +59,15 @@ export declare type AiOpenMode = 'launcher' | 'floating' | 'drawer' | 'fullscree
 
 export declare type AiThemeMode = 'system' | 'light' | 'dark' | 'custom';
 
+/** A backend-produced insight (never re-derived from rows on the client). */
+declare interface AnalysisInsight {
+    type: InsightType;
+    title: string;
+    detail: string;
+    /** Optional references to column keys / row indices backing the insight. */
+    refs?: string[];
+}
+
 export declare interface AssistantMessage {
     id: string;
     conversationId: string;
@@ -139,6 +158,76 @@ export declare interface AssistantState {
     lastError: string | null;
 }
 
+/**
+ * Card payload — discriminated union on `kind`. Mirrors Java `sealed interface
+ * CardData permits SqlCard, TableCard, ChartCard, MetricCard, SourceCard,
+ * SuggestionCard, GlossaryCard, AnalysisCard, CitationCard`.
+ */
+declare type CardData = {
+    kind: 'sql';
+    sql: string;
+    dialect: Dialect;
+    tables: string[];
+    estimatedRows: number;
+    isReadonly: boolean;
+    isSensitive: boolean;
+    explanation?: string;
+} | {
+    kind: 'table';
+    columns: ColumnDef[];
+    rows: Row[];
+    total: number;
+    truncated?: boolean;
+} | {
+    kind: 'chart';
+    spec: ChartSpec;
+} | {
+    kind: 'metric';
+    items: MetricItem[];
+} | {
+    kind: 'source';
+    items: SourceItem[];
+} | {
+    kind: 'suggestion';
+    items: SuggestionItem[];
+} | {
+    kind: 'glossary';
+    columns: ColumnDef[];
+} | {
+    kind: 'analysis';
+    insights: AnalysisInsight[];
+} | {
+    kind: 'citation';
+    items: CitationItem[];
+};
+
+/**
+ * v2 protocol — card payloads (discriminated union on `kind`).
+ *
+ * Per REARCHITECTURE-PLAN §4.3 / §4.4: rich content is delivered through a
+ * single `card` event whose `data` is a strongly-typed, `kind`-discriminated
+ * union. Adding a new card = adding a new `kind` here + one frontend registry
+ * entry; the core envelope (events.ts) never changes (CLAUDE.md §12 扩展预留).
+ *
+ * These types MUST stay shape-for-shape identical to the Java sealed records
+ * (`CardData` permits SqlCard/TableCard/... ) so the shared golden fixture
+ * (see __fixtures__/golden-events.ts) round-trips on both sides.
+ *
+ * Pure TS — zero Vue / framework dependency.
+ */
+/** Closed enum of card kinds. The `card` event carries one of these. */
+declare type CardKind = 'sql' | 'table' | 'chart' | 'metric' | 'source' | 'suggestion' | 'glossary' | 'analysis' | 'citation';
+
+/** A rich content card (sql / table / chart / metric / …). */
+export declare interface CardPart {
+    kind: 'card';
+    id: string;
+    cardKind: CardKind;
+    data: CardData;
+    transient?: boolean;
+    status?: string;
+}
+
 export declare interface ChartConfig {
     type: 'bar' | 'line' | 'pie' | 'heatmap' | 'gantt' | 'scatter';
     title: string;
@@ -146,6 +235,33 @@ export declare interface ChartConfig {
     options?: Record<string, unknown>;
 }
 
+/** Encoding: which column keys map to which visual channels. */
+declare interface ChartEncoding {
+    /** Column key for the x axis (category / time). */
+    x: string;
+    /** One or more column keys for the y axis (measures). */
+    y: string[];
+    /** Optional column key used to split into series. */
+    series?: string;
+}
+
+/**
+ * Closed enum of neutral chart kinds. `''` means "no suitable chart — fall back
+ * to table" (mirrors WrenAI's empty chart_type). Frontend maps these to ECharts.
+ */
+declare type ChartKind = '' | 'bar' | 'line' | 'pie' | 'scatter' | 'area' | 'grouped-bar' | 'stacked-bar';
+
+/**
+ * Neutral, framework-agnostic chart spec. Backend owns the spec; frontend owns
+ * the ECharts mapping. `data` is the full result set (rows) for plotting.
+ */
+declare interface ChartSpec {
+    chartKind: ChartKind;
+    title?: string;
+    encoding: ChartEncoding;
+    data: Row[];
+}
+
 export declare class ChunkMatcher {
     /**
      * Match parsed citations to a list of knowledge chunks.
@@ -184,6 +300,14 @@ export declare interface Citation {
     end: number;
 }
 
+/** A knowledge-base citation entry (Phase 2 预留). */
+declare interface CitationItem {
+    docName: string;
+    page: number;
+    section: string;
+    content: string;
+}
+
 export declare class CitationParser {
     /** Regex for citation markers: [1], [12], etc. */
     private static readonly MARKER_RE;
@@ -215,6 +339,36 @@ export declare class CitationParser {
 /** Clamp a number between min and max (inclusive). */
 export declare function clamp(value: number, min: number, max: number): number;
 
+/** A clarification request asking the user to choose or answer. */
+export declare interface ClarifyPart {
+    kind: 'clarify';
+    question: string;
+    options?: string[];
+}
+
+/**
+ * A result-table / glossary column. Semantic fields (displayName/role/...) come
+ * from the backend semantic layer — never re-derived on the client.
+ */
+declare interface ColumnDef {
+    key: string;
+    title: string;
+    type?: string;
+    /** Business-friendly Chinese name, e.g. "设备温度". */
+    displayName?: string;
+    /** Semantic role for analysis/charting. */
+    role?: ColumnRole;
+    /** Human description, e.g. "通信状态(0正常/1异常)". */
+    description?: string;
+    /** Display unit, e.g. "℃", "件". */
+    unit?: string;
+    /** Sensitive columns are stripped before the LLM; flagged here for UI only. */
+    sensitive?: boolean;
+}
+
+/** Semantic role of a result column (drives glossary + analysis). */
+declare type ColumnRole = 'dimension' | 'metric' | 'time';
+
 export declare interface Conversation {
     id: string;
     title: string;
@@ -290,6 +444,9 @@ export declare function deserialize(data: unknown): AssistantState | null;
 /** Convenience: deserialize from JSON string. */
 export declare function deserializeFromString(json: string): AssistantState | null;
 
+/** SQL dialect produced by the engine (closed set; never free-form). */
+declare type Dialect = 'mysql' | 'postgresql';
+
 export declare type ErrorCode = keyof typeof ErrorCodes;
 
 /**
@@ -333,6 +490,9 @@ export declare interface FeaturesConfig {
     enableActionConfirm?: boolean;
 }
 
+/** Why a run finished. */
+declare type FinishReason = 'stop' | 'length' | 'tool_calls' | 'content_filter' | 'error';
+
 /** Format a Date or timestamp to locale string. */
 export declare function formatDate(input: Date | number | string, options?: Intl.DateTimeFormatOptions): string;
 
@@ -352,6 +512,12 @@ export declare interface I18nConfig {
     messages?: Record<string, string>;
 }
 
+/** Factory for a blank accumulator. */
+export declare function initialState(): ReduceState;
+
+/** Type of an analysis insight (drives icon/severity on the client). */
+declare type InsightType = 'trend' | 'outlier' | 'comparison' | 'summary' | 'anomaly';
+
 /**
  * Check whether an error represents a user abort.
  */
@@ -372,6 +538,17 @@ export declare function isRetriable(error: unknown): boolean;
 
 export declare function isString(value: unknown): value is string;
 
+/**
+ * RFC 6902 JSON Patch op (subset) used by `card.patch` for in-place updates.
+ * Kept narrow on purpose; the transitional path may instead re-send the full
+ * `card` with the same id.
+ */
+declare interface JsonPatchOp {
+    op: 'add' | 'remove' | 'replace';
+    path: string;
+    value?: string | number | boolean | null | Record<string, unknown> | unknown[];
+}
+
 export declare interface KnowledgeChunk {
     /** Chunk index (1-based, matching citation numbers) */
     index: number;
@@ -390,12 +567,56 @@ export declare interface MatchedChunk extends KnowledgeChunk {
     citedBy: number[];
 }
 
+/** Internal indexes for the current (last) message. */
+declare interface MessageIndexes {
+    /** partId → index in `parts` for text/reasoning parts */
+    byPartId: Map<string, number>;
+    /** toolCallId → index in `parts` for tool parts */
+    byToolCallId: Map<string, number>;
+    /** card.id → index in `parts` for card parts */
+    byCardId: Map<string, number>;
+}
+
 export declare type MessageRole = 'user' | 'assistant' | 'system' | 'tool';
 
+/**
+ * Complete snapshot of a single assistant message at a point in time.
+ * Parts are ordered by the `seq` of their originating start event.
+ */
+export declare interface MessageSnapshot {
+    messageId: string;
+    conversationId: string;
+    status: RunStatus;
+    parts: Part[];
+    usage?: Usage;
+    finishReason?: FinishReason;
+    /** Wall-clock latency reported by the backend on `run.finish`. */
+    latencyMs?: number;
+    /** Timestamp (ms) when `run.start` was received. */
+    startedAt: number;
+}
+
 export declare type MessageStatus = 'pending' | 'streaming' | 'success' | 'failed';
 
 export declare type MessageType = 'text' | 'markdown' | 'chart' | 'table' | 'tool' | 'error' | 'sql' | 'metric' | 'action' | 'source';
 
+/** A single KPI / metric tile. Multiple tiles share one metric card. */
+declare interface MetricItem {
+    label: string;
+    value: string | number;
+    unit?: string;
+    trend?: MetricTrend;
+    /** Display format hint, e.g. "percent", "currency", "integer". */
+    format?: string;
+}
+
+/** A trend annotation on a metric value. */
+declare interface MetricTrend {
+    value: number;
+    direction: TrendDirection;
+    label?: string;
+}
+
 export declare interface ModelOption {
     code: string;
     name: string;
@@ -425,6 +646,9 @@ export declare interface PageContext {
     extras?: Record<string, unknown>;
 }
 
+/** Discriminated union of all renderable parts of an assistant turn. */
+export declare type Part = TextPart | ReasoningPart | ToolPart | CardPart | ActionPart | ClarifyPart;
+
 export declare interface PluginConfig {
     systemCode: string;
     defaultMode: string;
@@ -439,13 +663,55 @@ export declare interface PluginConfig {
     rateLimitPerHour: number;
 }
 
+/** Chain-of-thought reasoning block (optional; default not rendered). */
+export declare interface ReasoningPart {
+    kind: 'reasoning';
+    partId: string;
+    text: string;
+}
+
+/**
+ * Pure fold: given the current accumulator state and one v2 `StreamEvent`,
+ * return the next state. Never mutates `state`. Unknown event types are
+ * ignored silently.
+ */
+export declare function reduce(state: ReduceState, event: StreamEvent_2): ReduceState;
+
+/**
+ * Convenience fold: reduce an entire ordered sequence of events from scratch.
+ * Equivalent to `events.reduce(reduce, initialState())`.
+ */
+export declare function reduceAll(events: StreamEvent_2[]): ReduceState;
+
 export declare function reducer(state: AssistantState, action: StateAction): AssistantState;
 
+/**
+ * Accumulator state for `reduce`. Plain / serialisable (Maps are the only
+ * non-JSON-native field; callers that need JSON-round-trip should serialise
+ * them separately).
+ */
+export declare interface ReduceState {
+    /** Ordered list of assistant messages produced so far. */
+    messages: MessageSnapshot[];
+    /** Last `seq` accepted (used for duplicate/OOO filtering). */
+    lastSeq: number;
+    /* Excluded from this release type: _idx */
+}
+
 export declare interface RegisteredTool {
     definition: ToolDefinition;
     executor: ToolExecutor;
 }
 
+/** Risk level for a proposed write action (Action Center 二次确认). */
+declare type RiskLevel = 'safe' | 'caution' | 'danger';
+
+/** A single result row: column key → cell value. */
+declare type Row = Record<string, string | number | boolean | null>;
+
+/** Status of an assistant message lifetime (v2 reducer). */
+export declare type RunStatus = 'streaming' | 'complete' | 'error';
+
 /** Serialize state to JSON-safe object (excludes transient stream fields). */
 export declare function serialize(state: AssistantState): SerializedState;
 
@@ -457,6 +723,26 @@ export declare interface SerializedState {
 /** Convenience: serialize to JSON string. */
 export declare function serializeToString(state: AssistantState): string;
 
+/**
+ * A data-source provenance entry. Discriminated on `kind` to remove the v1
+ * polymorphism where `table` was sometimes a real table, sometimes a tool name.
+ */
+declare type SourceItem = {
+    kind: 'table';
+    name: string;
+    query?: string;
+    rowCount: number | null;
+    durationMs: number;
+    timestamp: string;
+} | {
+    kind: 'tool';
+    name: string;
+    query?: string;
+    rowCount: number | null;
+    durationMs: number;
+    timestamp: string;
+};
+
 export declare interface SourceRef {
     table: string;
     query: string;
@@ -783,6 +1069,141 @@ export declare type StreamEvent = {
     ts: number;
 };
 
+/**
+ * The full v2 stream-event union. Discriminated on `type`; every member carries
+ * a monotonic `seq`.
+ */
+declare type StreamEvent_2 = {
+    type: 'run.start';
+    seq: number;
+    conversationId: string;
+    messageId: string;
+} | {
+    type: 'run.finish';
+    seq: number;
+    reason: FinishReason;
+    usage: Usage;
+    latencyMs: number;
+} | {
+    type: 'run.error';
+    seq: number;
+    code: string;
+    message: string;
+    retriable: boolean;
+} | {
+    type: 'text.start';
+    seq: number;
+    partId: string;
+} | {
+    type: 'text.delta';
+    seq: number;
+    partId: string;
+    delta: string;
+} | {
+    type: 'text.end';
+    seq: number;
+    partId: string;
+} | {
+    type: 'reasoning.start';
+    seq: number;
+    partId: string;
+} | {
+    type: 'reasoning.delta';
+    seq: number;
+    partId: string;
+    delta: string;
+} | {
+    type: 'reasoning.end';
+    seq: number;
+    partId: string;
+} | {
+    type: 'tool.start';
+    seq: number;
+    toolCallId: string;
+    toolName: string;
+} | {
+    type: 'tool.input.delta';
+    seq: number;
+    toolCallId: string;
+    delta: string;
+} | {
+    type: 'tool.input';
+    seq: number;
+    toolCallId: string;
+    input: Record<string, string | number | boolean | null>;
+} | {
+    type: 'tool.executing';
+    seq: number;
+    toolCallId: string;
+} | {
+    type: 'tool.output';
+    seq: number;
+    toolCallId: string;
+    output: ToolOutput;
+    status: ToolStatus;
+} | {
+    type: 'tool.error';
+    seq: number;
+    toolCallId: string;
+    error: string;
+} | {
+    type: 'card';
+    seq: number;
+    id: string;
+    kind: CardKind;
+    data: CardData;
+    status?: string;
+    transient?: boolean;
+} | {
+    type: 'card.patch';
+    seq: number;
+    id: string;
+    patch: JsonPatchOp[];
+} | {
+    type: 'action.proposed';
+    seq: number;
+    actionId: string;
+    title: string;
+    summary?: string;
+    riskLevel: RiskLevel;
+    params: Record<string, string | number | boolean | null>;
+} | {
+    type: 'clarify';
+    seq: number;
+    question: string;
+    options?: string[];
+};
+
+/** Convenience: the closed set of v2 event `type` discriminants. */
+declare type StreamEventType = StreamEvent_2['type'];
+
+/** A structured follow-up suggestion (programmatically routable). */
+declare interface SuggestionItem {
+    text: string;
+    /** Optional intent code for programmatic routing. */
+    intent?: string;
+    /** Optional pre-filled params for the routed intent. */
+    params?: Record<string, string | number | boolean | null>;
+}
+
+/**
+ * A result-table column. The semantic fields (displayName/description/role) are
+ * optional and backward-compatible: when the backend populates them from the
+ * registered column metadata (ColumnConfigDTO) they drive the 字段说明 glossary
+ * and the table-header tooltip; when absent the table renders exactly as before.
+ */
+export declare interface TableColumn {
+    key: string;
+    title: string;
+    type?: string;
+    /** Business-friendly Chinese name (e.g. "虚拟温度") for the glossary. */
+    displayName?: string;
+    /** Human description of the column (e.g. "设备ID", "通信状态(0正常/1异常)"). */
+    description?: string;
+    /** Semantic role for analysis: dimension / metric / time. */
+    role?: 'dimension' | 'metric' | 'time';
+}
+
 export declare interface TableInfo {
     tableName: string;
     tableComment?: string;
@@ -795,15 +1216,18 @@ export declare interface TableInfo {
 }
 
 export declare interface TableResult {
-    columns: {
-        key: string;
-        title: string;
-        type?: string;
-    }[];
+    columns: TableColumn[];
     rows: Record<string, unknown>[];
     total?: number;
 }
 
+/** A streamed text block (main reply or continuation). */
+export declare interface TextPart {
+    kind: 'text';
+    partId: string;
+    text: string;
+}
+
 export declare function throttle<T extends (...args: unknown[]) => unknown>(fn: T, waitMs: number, options?: {
     leading?: boolean;
     trailing?: boolean;
@@ -849,6 +1273,38 @@ export declare class ToolOrchestrator {
     private executeParallel;
 }
 
+/**
+ * Structured tool result (replaces v1's perpetually-null `result`). Always a
+ * populated object describing what the tool did.
+ */
+declare interface ToolOutput {
+    executed: boolean;
+    rowCount?: number;
+    durationMs?: number;
+    /** Optional human-readable summary of the tool outcome. */
+    summary?: string;
+    /** Optional structured payload (kept open for tool-specific extras). */
+    data?: Record<string, string | number | boolean | null>;
+}
+
+/** A tool invocation with full lifecycle state. */
+export declare interface ToolPart {
+    kind: 'tool';
+    toolCallId: string;
+    toolName: string;
+    status: ToolPartStatus;
+    /** Accumulated raw JSON string of the input (from `tool.input.delta`). */
+    inputRaw?: string;
+    /** Authoritative parsed input (from `tool.input`). */
+    input?: Record<string, string | number | boolean | null>;
+    output?: ToolOutput;
+    outputStatus?: ToolStatus;
+    error?: string;
+}
+
+/** Status of a tool call across its state machine. */
+export declare type ToolPartStatus = 'pending' | 'input-streaming' | 'input-ready' | 'executing' | 'output-available' | 'output-error';
+
 export declare class ToolRegistry {
     private readonly tools;
     /** Register a tool with its definition and executor. */
@@ -867,6 +1323,9 @@ export declare class ToolRegistry {
     clear(): void;
 }
 
+/** Tool-call lifecycle status carried by `tool.output`. */
+declare type ToolStatus = 'output-available' | 'output-error';
+
 export declare interface ToolStep {
     stepId: string;
     toolName: string;
@@ -892,6 +1351,16 @@ export declare interface TransportConfig {
     fetchFallback?: boolean;
 }
 
+/** Direction of a metric trend. */
+declare type TrendDirection = 'up' | 'down' | 'flat';
+
+/** Token usage, filled authoritatively on `run.finish` (fixes v1 durationMs=0). */
+declare interface Usage {
+    prompt: number;
+    completion: number;
+    total: number;
+}
+
 export declare interface UserInfo {
     userId: string;
     username: string;
@@ -901,4 +1370,35 @@ export declare interface UserInfo {
     dataScope?: 'all' | 'org' | 'area' | 'self';
 }
 
+declare namespace v2 {
+    export {
+        StreamEvent_2 as StreamEvent,
+        StreamEventType,
+        Usage,
+        FinishReason,
+        ToolStatus,
+        ToolOutput,
+        RiskLevel,
+        JsonPatchOp,
+        CardData,
+        CardKind,
+        Dialect,
+        ColumnRole,
+        ColumnDef,
+        Row,
+        ChartKind,
+        ChartEncoding,
+        ChartSpec,
+        TrendDirection,
+        MetricTrend,
+        MetricItem,
+        SourceItem,
+        SuggestionItem,
+        InsightType,
+        AnalysisInsight,
+        CitationItem
+    }
+}
+export { v2 }
+
 export { }