@dmsfe/data-agent-sdk 0.1.0

package/CHANGES.md

@@ -0,0 +1,33 @@
+# Changelog
+
+## 0.1.0 — 2026-05-21
+
+Initial stable 0.x release.
+
+### Added
+
+- **Layer 1 types** — `ChartType`, `ChartData`, `ContentType`, `TaskFinishChart`, `TaskFinishCharts`, `TaskFinishToolArgs`, `TaskFinishChartData`, `DataAgentEvent`, `ParsedTaskFinishContent`.
+- **Layer 2 parsers** — `parseDataAgentSSE` (bytes → events, with signal + consumer-break cancellation), `parseDataAgentChunks` (sync array / async iterable overloads), `parseTaskFinishContent`, `parseChartData`.
+- **Layer 3 render** (subpath `./render`) — `renderTaskFinishChart` / `renderTaskFinishCharts` (wire wrappers), `renderTaskFinishChartData` / `renderTaskFinishChartsData` (structured core). Supports `chart_type: bar | line | pie | table | number`; unknown types are silent no-op.
+- `RendererInstance<TData>` generic + `ChartInstance` / `ChartsInstance` aliases.
+- `TaskFinishRenderOptions.chartHeight` for multi-chart renderers. Defaults to `300px` per child chart host; numbers are treated as px and strings as CSS height values.
+- CSS-variable theming (`--dmsfe-chart-category-1..12`, `--dmsfe-chart-sequential-1..8`).
+- Bundled internal deps: `zod ^4`, `@ai-sdk/provider-utils ^3`. `echarts ^5` as optional peer.
+- Built with tsup → ESM + CJS + DTS. `sideEffects: false`.
+- npm package metadata supports Node 18 ESM consumers via `type: module` while preserving CJS `require` entry points.
+- 发布包不包含 source map，并开启 minify 以降低 npm tarball 体积。
+
+### Bundle size baseline (measured at first build)
+
+- `lib/index.js`: ~73KB gz (Layer 1 + 2 + bundled `zod` + `@ai-sdk/provider-utils`).
+- `lib/render/index.js`: ~72KB gz (Layer 3 + bundled `zod` + shared DOM scaffold; `echarts` external).
+
+Re-measure with `gzip -c lib/index.js | wc -c` and `gzip -c lib/render/index.js | wc -c`.
+
+These are higher than initially estimated in the spec because `@ai-sdk/provider-utils` and `zod 4` together compress to more than the back-of-envelope guess. The trade-off is intentional: bundling them keeps the customer's `node_modules` minimal and removes version-conflict surface, at the cost of a larger one-time SDK download.
+
+Subsequent releases that increase any entry by >20% must include a note explaining why.
+
+---
+
+Versioning policy: 0.x minors may include breaking API changes (documented here). 1.0 will be cut after (a) ≥3 customers integrated, (b) ≥3 months without breaking changes, (c) Phase 2 dependency inversion completed.

package/LICENSE

@@ -0,0 +1,201 @@
+                                 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 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 accept 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 [yyyy] [name of copyright owner]
+
+   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.

package/README.md

@@ -0,0 +1,212 @@
+# @dmsfe/data-agent-sdk
+
+面向 [DMS Data Agent](https://agent.dms.aliyun.com) 的前端无框架 UI SDK：用于解析 Data Agent SSE 响应，并在任意前端技术栈（React、Vue、Svelte、Vanilla JS 等）中渲染 `task_finish` 图表。
+
+> **状态：0.x 实验版本。** Minor 版本中 API 仍可能调整。变更记录见 [CHANGES.md](./CHANGES.md)。
+
+## 安装
+
+```bash
+pnpm add @dmsfe/data-agent-sdk
+# 或 npm install / yarn add
+
+# 如果使用 /render 子路径，需要同时安装：
+pnpm add echarts
+```
+
+## 快速开始
+
+```ts
+import {
+  parseDataAgentSSE,
+  parseTaskFinishContent,
+} from '@dmsfe/data-agent-sdk';
+import { renderTaskFinishCharts } from '@dmsfe/data-agent-sdk/render';
+
+const response = await fetch('/openapi/SendChatMessage', { /* ... */ });
+const container = document.getElementById('charts')!;
+
+for await (const event of parseDataAgentSSE(response.body!)) {
+  if (event.type !== 'task_finish') continue;
+  const parsed = parseTaskFinishContent(event.payload.content, event.payload.content_type);
+  if (parsed.type === 'charts') {
+    renderTaskFinishCharts(container, parsed.charts, { chartHeight: 320 });
+  }
+}
+```
+
+## 框架集成
+
+### React
+
+```tsx
+import { useEffect, useMemo, useRef } from 'react';
+import { parseTaskFinishContent, type TaskFinishToolArgs } from '@dmsfe/data-agent-sdk';
+import { renderTaskFinishCharts, type ChartsInstance } from '@dmsfe/data-agent-sdk/render';
+
+export function TaskFinishView({ payload }: { payload: TaskFinishToolArgs }) {
+  const ref = useRef<HTMLDivElement>(null);
+  const parsed = useMemo(
+    () => parseTaskFinishContent(payload.content, payload.content_type),
+    [payload.content, payload.content_type],
+  );
+  useEffect(() => {
+    if (parsed.type !== 'charts' || !ref.current) return;
+    const inst: ChartsInstance = renderTaskFinishCharts(ref.current, parsed.charts, {
+      chartHeight: 320,
+    });
+    return () => inst.destroy();
+  }, [parsed]);
+  if (parsed.type === 'markdown') return <pre>{parsed.content}</pre>;
+  return <div ref={ref} />;
+}
+```
+
+### Vue 3
+
+```vue
+<script setup lang="ts">
+import { ref, computed, watchEffect, onBeforeUnmount } from 'vue';
+import { parseTaskFinishContent, type TaskFinishToolArgs } from '@dmsfe/data-agent-sdk';
+import { renderTaskFinishCharts, type ChartsInstance } from '@dmsfe/data-agent-sdk/render';
+
+const props = defineProps<{ payload: TaskFinishToolArgs }>();
+const parsed = computed(() => parseTaskFinishContent(props.payload.content, props.payload.content_type));
+const el = ref<HTMLElement>();
+let inst: ChartsInstance | undefined;
+
+watchEffect(() => {
+  inst?.destroy(); inst = undefined;
+  if (parsed.value.type === 'charts' && el.value) {
+    inst = renderTaskFinishCharts(el.value, parsed.value.charts, {
+      chartHeight: 320,
+    });
+  }
+});
+onBeforeUnmount(() => inst?.destroy());
+</script>
+<template>
+  <pre v-if="parsed.type === 'markdown'">{{ parsed.content }}</pre>
+  <div v-else ref="el" />
+</template>
+```
+
+### Vanilla JS
+
+参考上面的“快速开始”示例。
+
+## 其他输入方式：`parseDataAgentChunks`
+
+如果你的 HTTP 层已经把 SSE 响应解码成 JSON 对象，或者你手里有一组已捕获的日志对象，可以直接使用 `parseDataAgentChunks`，不需要再使用 `parseDataAgentSSE`：
+
+```ts
+import { parseDataAgentChunks } from '@dmsfe/data-agent-sdk';
+
+const events = parseDataAgentChunks(myDecodedChunkArray);    // 同步数组输入，返回数组
+// 或
+for await (const e of parseDataAgentChunks(myAsyncIterable, { signal })) { /* ... */ }
+```
+
+## 独立渲染：`renderTaskFinishChartData`
+
+用于测试、Storybook fixture，或回放已经解码好的结构化 payload：
+
+```ts
+import { renderTaskFinishChartData } from '@dmsfe/data-agent-sdk/render';
+
+renderTaskFinishChartData(document.getElementById('chart')!, {
+  title: 'Monthly Sales',
+  chart_type: 'bar',
+  data: { columns: ['m', 'v'], data: [['Jan', 10], ['Feb', 20]] },
+});
+```
+
+使用单图渲染器（`renderTaskFinishChart` 或 `renderTaskFinishChartData`）时，需要在渲染前给目标容器设置非零高度：
+
+```html
+<div id="chart" style="height: 320px"></div>
+```
+
+多图渲染器（`renderTaskFinishCharts` 和 `renderTaskFinishChartsData`）会为每张图创建一个子容器，默认每个子容器高度为 `300px`。可以通过 `options.chartHeight` 覆盖。
+
+**适用范围说明**：该渲染入口面向 Data Agent 已解码的 payload。SDK 不是通用图表库；`chart_type` 枚举和字段推断规则都跟随 Data Agent 的 `task_finish` 协议。如果要渲染任意业务图表，建议直接使用 echarts。
+
+## API 参考
+
+### Layer 1：类型
+
+- `ChartType` = `string | null`
+- `ChartData`：`{ columns: string[], data: (string|number|null)[][] }`
+- `ContentType` = `'str' | 'json' | undefined`
+- `TaskFinishChart`：wire 格式，`data` 字段是 JSON 字符串
+- `TaskFinishCharts` = `TaskFinishChart[]`
+- `TaskFinishChartData`：结构化格式，`data` 字段是 `ChartData`
+- `TaskFinishToolArgs`：`{ content: string, content_type? }`
+- `DataAgentEvent` = `{ type: 'task_finish'; payload } | { type: 'unknown'; raw }`
+- `ParsedTaskFinishContent` = `{ type: 'markdown'; content } | { type: 'charts'; charts }`
+
+### Layer 2：解析器
+
+- `parseDataAgentSSE(stream, { signal? })` → `AsyncIterable<DataAgentEvent>`
+- `parseDataAgentChunks(chunks)` → `DataAgentEvent[]`（数组重载）
+- `parseDataAgentChunks(iterable, { signal? })` → `AsyncIterable<DataAgentEvent>`
+- `parseTaskFinishContent(content, contentType?)` → `ParsedTaskFinishContent`
+- `parseChartData(jsonString)` → `ChartData | null`
+
+### Layer 3：渲染器（从 `/render` 子路径导入）
+
+- `renderTaskFinishChart(container, chart, options?)` → `ChartInstance`
+- `renderTaskFinishCharts(container, charts, options?)` → `ChartsInstance`
+- `renderTaskFinishChartData(container, input, options?)` → `RendererInstance<TaskFinishChartData>`
+- `renderTaskFinishChartsData(container, inputs, options?)` → `RendererInstance<TaskFinishChartData[]>`
+
+### 渲染选项
+
+```ts
+interface TaskFinishRenderOptions {
+  theme?: 'light' | 'dark';
+  locale?: 'zh-CN' | 'en-US';
+  chartHeight?: number | string;
+  onUnknownChartType?: (chartType: string | null) => void;
+}
+```
+
+| 选项 | 适用范围 | 默认值 | 说明 |
+|---|---|---|---|
+| `theme` | 所有渲染器 | 浏览器 / echarts 默认主题 | 预留给渲染器主题选择。 |
+| `locale` | 所有渲染器 | 根据浏览器语言自动判断 | 控制内置兜底文案，例如空数据提示。 |
+| `chartHeight` | 多图渲染器 | `300` | `renderTaskFinishCharts` / `renderTaskFinishChartsData` 创建的每个子图表容器高度。数字会按 px 处理；字符串会作为 CSS 高度值使用，例如 `'24rem'`。 |
+| `onUnknownChartType` | 所有渲染器 | `undefined` | 当 `chart_type` 为 `null` 或不支持的类型时触发。 |
+
+### 图表类型
+
+| `chart_type` | 渲染结果 |
+|---|---|
+| `'bar'` | echarts 柱状图 |
+| `'line'` | echarts 折线图 |
+| `'pie'` | echarts 饼图 |
+| `'table'` | 原生 HTML `<table>`，不创建 echarts 实例 |
+| `'number'` | 原生 DOM 指标卡，不创建 echarts 实例 |
+| `null` 或其他值 | 不渲染图表，可通过 `onUnknownChartType` 回调感知 |
+
+### CSS 变量（主题）
+
+可以在图表容器的任意祖先节点上覆盖以下 CSS 变量：
+
+- `--dmsfe-chart-category-1` 到 `--dmsfe-chart-category-12`：分类色板，默认是阿里云蓝色系与辅助色
+- `--dmsfe-chart-sequential-1` 到 `--dmsfe-chart-sequential-8`：连续色板，默认是品牌蓝色系
+
+## 限制（Phase 1）
+
+- 目前只有 `task_finish` SSE 事件会被解析成强类型；其他 category 会作为 `{ type: 'unknown', raw }` 返回。
+- 暂不提供 React/Vue 组件层，当前使用命令式 API。
+- 暂不支持 notebook cell output、plan progress、mission report 等渲染器，这些会放到后续阶段。
+- `ParsedTaskFinishContent.type === 'markdown'` 分支暂不提供内置 Markdown 渲染器。
+
+## 路线图
+
+- Phase 2：框架适配包、更多事件类型和渲染器（例如 `output_conclusion` Markdown 卡片、`plan_update` 进度可视化等），并完成与 `apps/data-agent` 的依赖反转。
+
+## License
+
+Apache-2.0