@frost1994/agentic-core 1.0.0 → 1.0.3

package/dist/protocol.d.ts

@@ -15,6 +15,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;
@@ -58,6 +67,66 @@ export declare interface AssistantMessage {
     };
 }
 
+/**
+ * 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';
+
 export declare interface ChartConfig {
     type: 'bar' | 'line' | 'pie' | 'heatmap' | 'gantt' | 'scatter';
     title: string;
@@ -65,6 +134,64 @@ 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[];
+}
+
+/** A knowledge-base citation entry (Phase 2 预留). */
+declare interface CitationItem {
+    docName: string;
+    page: number;
+    section: string;
+    content: 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;
@@ -102,6 +229,9 @@ export declare interface CreateAiAssistantOptions {
     onEvent?: (event: unknown) => void;
 }
 
+/** SQL dialect produced by the engine (closed set; never free-form). */
+declare type Dialect = 'mysql' | 'postgresql';
+
 export declare interface FeaturesConfig {
     enableVoice?: boolean;
     enableFileUpload?: boolean;
@@ -112,17 +242,51 @@ export declare interface FeaturesConfig {
     enableActionConfirm?: boolean;
 }
 
+/** Why a run finished. */
+declare type FinishReason = 'stop' | 'length' | 'tool_calls' | 'content_filter' | 'error';
+
 export declare interface I18nConfig {
     locale?: string;
     messages?: Record<string, string>;
 }
 
+/** Type of an analysis insight (drives icon/severity on the client). */
+declare type InsightType = 'trend' | 'outlier' | 'comparison' | 'summary' | 'anomaly';
+
+/**
+ * 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 type MessageRole = 'user' | 'assistant' | 'system' | 'tool';
 
 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;
@@ -144,6 +308,32 @@ export declare interface PageContext {
     extras?: Record<string, unknown>;
 }
 
+/** 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>;
+
+/**
+ * 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;
@@ -235,12 +425,143 @@ 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 TableResult {
-    columns: {
-        key: string;
-        title: string;
-        type?: string;
-    }[];
+    columns: TableColumn[];
     rows: Record<string, unknown>[];
     total?: number;
 }
@@ -261,6 +582,23 @@ export declare interface ToolDefinition {
 
 export declare type ToolExecutor = (args: Record<string, unknown>) => Promise<unknown>;
 
+/**
+ * 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>;
+}
+
+/** Tool-call lifecycle status carried by `tool.output`. */
+declare type ToolStatus = 'output-available' | 'output-error';
+
 export declare interface ToolStep {
     stepId: string;
     toolName: string;
@@ -286,6 +624,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;
@@ -295,4 +643,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 { }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@frost1994/agentic-core",
-  "version": "1.0.0",
+  "version": "1.0.3",
   "description": "AI 助手纯逻辑引擎（无 Vue 依赖）",
   "license": "Apache-2.0",
   "author": "frost1994",

package/LICENSE

@@ -1,201 +0,0 @@
-                                 Apache License
-                           Version 2.0, January 2004
-                        http://www.apache.org/licenses/
-
-   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
-
-   1. Definitions.
-
-      "License" shall mean the terms and conditions for use, reproduction,
-      and distribution as defined by Sections 1 through 9 of this document.
-
-      "Licensor" shall mean the copyright owner or entity authorized by
-      the copyright owner that is granting the License.
-
-      "Legal Entity" shall mean the union of the acting entity and all
-      other entities that control, are controlled by, or are under common
-      control with that entity. For the purposes of this definition,
-      "control" means (i) the power, direct or indirect, to cause the
-      direction or management of such entity, whether by contract or
-      otherwise, or (ii) ownership of fifty percent (50%) or more of the
-      outstanding shares, or (iii) beneficial ownership of such entity.
-
-      "You" (or "Your") shall mean an individual or Legal Entity
-      exercising permissions granted by this License.
-
-      "Source" form shall mean the preferred form for making modifications,
-      including but not limited to software source code, documentation
-      source, and configuration files.
-
-      "Object" form shall mean any form resulting from mechanical
-      transformation or translation of a Source form, including but
-      not limited to compiled object code, generated documentation,
-      and conversions to other media types.
-
-      "Work" shall mean the work of authorship, whether in Source or
-      Object form, made available under the License, as indicated by a
-      copyright notice that is included in or attached to the work
-      (an example is provided in the Appendix below).
-
-      "Derivative Works" shall mean any work, whether in Source or Object
-      form, that is based on (or derived from) the Work and for which the
-      editorial revisions, annotations, elaborations, or other modifications
-      represent, as a whole, an original work of authorship. For the purposes
-      of this License, Derivative Works shall not include works that remain
-      separable from, or merely link (or bind by name) to the interfaces of,
-      the Work and Derivative Works thereof.
-
-      "Contribution" shall mean any work of authorship, including
-      the original version of the Work and any modifications or additions
-      to that Work or Derivative Works thereof, that is intentionally
-      submitted to Licensor for inclusion in the Work by the copyright owner
-      or by an individual or Legal Entity authorized to submit on behalf of
-      the copyright owner. For the purposes of this definition, "submitted"
-      means any form of electronic, verbal, or written communication sent
-      to the Licensor or its representatives, including but not limited to
-      communication on electronic mailing lists, source code control systems,
-      and issue tracking systems that are managed by, or on behalf of, the
-      Licensor for the purpose of discussing and improving the Work, but
-      excluding communication that is conspicuously marked or otherwise
-      designated in writing by the copyright owner as "Not a Contribution."
-
-      "Contributor" shall mean Licensor and any individual or Legal Entity
-      on behalf of whom a Contribution has been received by Licensor and
-      subsequently incorporated within the Work.
-
-   2. Grant of Copyright License. Subject to the terms and conditions of
-      this License, each Contributor hereby grants to You a perpetual,
-      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
-      copyright license to reproduce, prepare Derivative Works of,
-      publicly display, publicly perform, sublicense, and distribute the
-      Work and such Derivative Works in Source or Object form.
-
-   3. Grant of Patent License. Subject to the terms and conditions of
-      this License, each Contributor hereby grants to You a perpetual,
-      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
-      (except as stated in this section) patent license to make, have made,
-      use, offer to sell, sell, import, and otherwise transfer the Work,
-      where such license applies only to those patent claims licensable
-      by such Contributor that are necessarily infringed by their
-      Contribution(s) alone or by combination of their Contribution(s)
-      with the Work to which such Contribution(s) was submitted. If You
-      institute patent litigation against any entity (including a
-      cross-claim or counterclaim in a lawsuit) alleging that the Work
-      or a Contribution incorporated within the Work constitutes direct
-      or contributory patent infringement, then any patent licenses
-      granted to You under this License for that Work shall terminate
-      as of the date such litigation is filed.
-
-   4. Redistribution. You may reproduce and distribute copies of the
-      Work or Derivative Works thereof in any medium, with or without
-      modifications, and in Source or Object form, provided that You
-      meet the following conditions:
-
-      (a) You must give any other recipients of the Work or Derivative
-          Works a copy of this License; and
-
-      (b) You must cause any modified files to carry prominent notices
-          stating that You changed the files; and
-
-      (c) You must retain, in the Source form of any Derivative Works
-          that You distribute, all copyright, patent, trademark, and
-          attribution notices from the Source form of the Work,
-          excluding those notices that do not pertain to any part of
-          the Derivative Works; and
-
-      (d) If the Work includes a "NOTICE" text file as part of its
-          distribution, then any Derivative Works that You distribute must
-          include a readable copy of the attribution notices contained
-          within such NOTICE file, excluding those notices that do not
-          pertain to any part of the Derivative Works, in at least one
-          of the following places: within a NOTICE text file distributed
-          as part of the Derivative Works; within the Source form or
-          documentation, if provided along with the Derivative Works; or,
-          within a display generated by the Derivative Works, if and
-          wherever such third-party notices normally appear. The contents
-          of the NOTICE file are for informational purposes only and
-          do not modify the License. You may add Your own attribution
-          notices within Derivative Works that You distribute, alongside
-          or as an addendum to the NOTICE text from the Work, provided
-          that such additional attribution notices cannot be construed
-          as modifying the License.
-
-      You may add Your own copyright statement to Your modifications and
-      may provide additional or different license terms and conditions
-      for use, reproduction, or distribution of Your modifications, or
-      for any such Derivative Works as a whole, provided Your use,
-      reproduction, and distribution of the Work otherwise complies with
-      the conditions stated in this License.
-
-   5. Submission of Contributions. Unless You explicitly state otherwise,
-      any Contribution intentionally submitted for inclusion in the Work
-      by You to the Licensor shall be under the terms and conditions of
-      this License, without any additional terms or conditions.
-      Notwithstanding the above, nothing herein shall supersede or modify
-      the terms of any separate license agreement you may have executed
-      with Licensor regarding such Contributions.
-
-   6. Trademarks. This License does not grant permission to use the trade
-      names, trademarks, service marks, or product names of the Licensor,
-      except as required for reasonable and customary use in describing the
-      origin of the Work and reproducing the content of the NOTICE file.
-
-   7. Disclaimer of Warranty. Unless required by applicable law or
-      agreed to in writing, Licensor provides the Work (and each
-      Contributor provides its Contributions) on an "AS IS" BASIS,
-      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
-      implied, including, without limitation, any warranties or conditions
-      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
-      PARTICULAR PURPOSE. You are solely responsible for determining the
-      appropriateness of using or redistributing the Work and assume any
-      risks associated with Your exercise of permissions under this License.
-
-   8. Limitation of Liability. In no event and under no legal theory,
-      whether in tort (including negligence), contract, or otherwise,
-      unless required by applicable law (such as deliberate and grossly
-      negligent acts) or agreed to in writing, shall any Contributor be
-      liable to You for damages, including any direct, indirect, special,
-      incidental, or consequential damages of any character arising as a
-      result of this License or out of the use or inability to use the
-      Work (including but not limited to damages for loss of goodwill,
-      work stoppage, computer failure or malfunction, or any and all
-      other commercial damages or losses), even if such Contributor
-      has been advised of the possibility of such damages.
-
-   9. Accepting Warranty or Additional Liability. While redistributing
-      the Work or Derivative Works thereof, You may choose to offer,
-      and charge a fee for, acceptance of support, warranty, indemnity,
-      or other liability obligations and/or rights consistent with this
-      License. However, in accepting such obligations, You may act only
-      on Your own behalf and on Your sole responsibility, not on behalf
-      of any other Contributor, and only if You agree to indemnify,
-      defend, and hold each Contributor harmless for any liability
-      incurred by, or claims asserted against, such Contributor by reason
-      of your accepting any such warranty or additional liability.
-
-   END OF TERMS AND CONDITIONS
-
-   APPENDIX: How to apply the Apache License to your work.
-
-      To apply the Apache License to your work, attach the following
-      boilerplate notice, with the fields enclosed by brackets "[]"
-      replaced with your own identifying information. (Don't include
-      the brackets!)  The text should be enclosed in the appropriate
-      comment syntax for the file format. We also recommend that a
-      file or class name and description of purpose be included on the
-      same "printed page" as the copyright notice for easier
-      identification within third-party archives.
-
-   Copyright 2026 frost1994
-
-   Licensed under the Apache License, Version 2.0 (the "License");
-   you may not use this file except in compliance with the License.
-   You may obtain a copy of the License at
-
-       http://www.apache.org/licenses/LICENSE-2.0
-
-   Unless required by applicable law or agreed to in writing, software
-   distributed under the License is distributed on an "AS IS" BASIS,
-   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-   See the License for the specific language governing permissions and
-   limitations under the License.