@nonefire/dsh-drender-plugin 0.0.0-stage → 0.1.2

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 NoneFire
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,3 +1,39 @@
-# Temporary Holding Version
+# @nonefire/dsh-drender-plugin
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+为 DeepSeek Harness 提供 drender 适配器，注册 `drender_validate`、`drender_render` 两个工具，并注册运行时 Skill `drender-report`。
+
+通用 Skill 源文件为 [`../../../.agents/skills/drender-report/SKILL.md`](../../../.agents/skills/drender-report/SKILL.md)。构建时会复制到 `lib/skills/drender-report/SKILL.md`，请只维护共享源文件。
+
+## 环境要求
+
+- Node.js 22.13 或更高版本。
+- DSH 已挂载公开的 `@deepseek-ai/dsh-tools`、`@deepseek-ai/dsh-skill` 服务，并启用了供模型加载 Skill 的消费者。
+- 读取 Markdown frontmatter 中声明的 SQLite 与 SQL 文件需要 DSH Session 工作区文件系统服务。
+- 侧栏 HTML 预览需要 Session 工作区；Web profile 还需要 DSH 的 `ui-tool`、`ui-slots`、`ui-renderer` 和 `ui-primitives` 模块。附件服务是可选的。
+
+插件仅依赖 DSH 公布的 Cordis、tools、skill、attachment 和客户端 UI API，不导入 DSH 应用源码或私有包。
+
+## 安装
+
+发布后，将插件安装到所选 profile：
+
+```sh
+dsh plugin --profile web add @nonefire/dsh-drender-plugin
+```
+
+Renderer、CSV/SQLite 数据源和主题代码均已打进这个插件包，不需要单独安装 drender 的其他 npm 包。图表与 Markdown 解析器等第三方运行时由 npm 自动安装；DSH 自身 API 由宿主提供。在源码开发环境中，将 `cordis.patch.yml` 的插件条目加入 profile 配置；稳定 ID 为 `md-report-dsh`，名称必须与包名及 `src/index.ts` 导出一致。
+
+## 工具
+
+- `drender_validate`：校验必需 frontmatter、dashboard/panel 结构、组件配置、数据集引用、安全链接和图片资源。诊断包含行号与报告路径。
+- `drender_render`：生成包含主题和所需图表运行时的自包含 HTML，保存 Markdown 源文件；宿主支持时还会生成右侧栏预览和下载附件。若 HTML 存储不可用，工具会返回有长度上限的 Markdown 预览。
+
+数据组件从声明的只读 SQLite 查询或显式传入的快照读取。Frontmatter 可声明一个 SQLite 文件，并通过 SQL sidecar、命名 view 或短内联查询声明数据集和 Excalidraw 场景。数据库与 SQL 路径必须位于 Session 工作区内。查询只允许只读语句，每个数据集最多 5,000 行，SQL 文件最多 100 KB，图片输入总量最多 8 MB，数据快照总量上限为 1 MB。
+
+`drender_render` 会把渲染后的 HTML 与对应快照嵌入导出文件，因此离线可用。内联 `datasets` 或 `assets` 参数不会写回 Markdown，会产生可移植性提示；可重复使用的报告应保留 Markdown、SQLite 文件、SQL sidecar 和图片资源。
+
+## 组件覆盖
+
+支持普通 Markdown、自动目录、提示条、12 列 dashboard 面板、正文分栏和折叠详情；KPI、ECharts、Tabulator 数据表、SQL、Mermaid、AntV Infographic、Excalidraw SVG、AntV T8 和声明式图片资源。图表、数据表和 Excalidraw 数据可通过 frontmatter 声明的 SQLite 数据源提供。
+
+导出 HTML 内嵌样式、必要的开源可视化运行时和所引用资源，使用基于哈希的内容安全策略。导出文件是数据快照；请勿在其中放入秘密或凭据。

package/cordis.patch.yml

@@ -0,0 +1,3 @@
+- insert:
+    - id: md-report-dsh
+      name: '@nonefire/dsh-drender-plugin'

package/lib/client.js

@@ -0,0 +1,138 @@
+window.__ModuleLoader__.load({ id: "@nonefire/dsh-drender-plugin", factory: (require) => { var module = { exports: {} }; var exports = module.exports;
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// plugins/hosts/dsh/src/client/index.ts
+var index_exports = {};
+__export(index_exports, {
+  apply: () => apply,
+  inject: () => inject
+});
+module.exports = __toCommonJS(index_exports);
+var import_react2 = require("react");
+
+// plugins/hosts/dsh/src/client/RenderToolRow.ts
+var import_react = require("react");
+var import_dsh_client_ui_primitives = require("@deepseek-ai/dsh-client-ui-primitives");
+function isRecord(value) {
+  return typeof value === "object" && value !== null;
+}
+function readMeta(value) {
+  if (!isRecord(value) || value.kind !== "md-report-render") return void 0;
+  return {
+    kind: "md-report-render",
+    status: typeof value.status === "string" ? value.status : "unknown",
+    title: typeof value.title === "string" ? value.title : "md-report",
+    sourcePath: typeof value.sourcePath === "string" ? value.sourcePath : "",
+    sourceWorkspacePath: typeof value.sourceWorkspacePath === "string" ? value.sourceWorkspacePath : "",
+    previewPath: typeof value.previewPath === "string" ? value.previewPath : "",
+    previewWorkspacePath: typeof value.previewWorkspacePath === "string" ? value.previewWorkspacePath : "",
+    fileName: typeof value.fileName === "string" ? value.fileName : "",
+    bytes: typeof value.bytes === "number" ? value.bytes : 0
+  };
+}
+function resultText(content) {
+  if (!content) return "";
+  return content.flatMap((block) => {
+    if (!isRecord(block) || block.type !== "text" || typeof block.text !== "string") return [];
+    return [block.text];
+  }).join("\n");
+}
+function formatBytes(bytes) {
+  if (!Number.isFinite(bytes) || bytes <= 0) return "";
+  return bytes < 1024 * 1024 ? `${Math.ceil(bytes / 1024)} KB` : `${(bytes / (1024 * 1024)).toFixed(1)} MB`;
+}
+function safeWorkspaceFile(path, extension) {
+  return Boolean(path) && !path.startsWith("/") && !path.includes("\\") && !/[\u0000-\u001f\u007f]/.test(path) && extension.test(path) && path.split("/").every((part) => part !== "" && part !== "." && part !== "..");
+}
+function RenderToolRow(props) {
+  const [openError, setOpenError] = (0, import_react.useState)("");
+  if (props.phase === "preparing") {
+    return (0, import_react.createElement)("div", { role: "status" }, "\u51C6\u5907\u6E32\u67D3\u62A5\u544A\u2026");
+  }
+  if (props.phase === "start") {
+    return (0, import_react.createElement)("div", { role: "status" }, "\u6B63\u5728\u6E32\u67D3\u62A5\u544A\u2026");
+  }
+  const meta = readMeta(props.block.meta);
+  const body = resultText(props.block.content);
+  if (!meta) {
+    return (0, import_react.createElement)("div", { role: props.block.isError ? "alert" : "status" }, body || (props.block.isError ? "\u62A5\u544A\u6E32\u67D3\u5931\u8D25\u3002" : "\u62A5\u544A\u6E32\u67D3\u5DF2\u7ED3\u675F\u3002"));
+  }
+  const summary = meta.status === "rendered" ? `${meta.title} \xB7 ${formatBytes(meta.bytes) || meta.fileName}` : meta.status === "storage-failed" ? `${meta.title} \xB7 HTML \u5DF2\u751F\u6210\uFF0C\u9884\u89C8\u6587\u4EF6\u4FDD\u5B58\u5931\u8D25` : `${meta.title} \xB7 ${meta.status}`;
+  const sourceCanOpen = safeWorkspaceFile(meta.sourceWorkspacePath, /\.(?:md|markdown)$/i);
+  const htmlCanOpen = safeWorkspaceFile(meta.previewWorkspacePath, /\.html$/i);
+  const openWorkspaceFile = (path, label, ariaLabel) => typeof props.openFile === "function" ? (0, import_react.createElement)(import_dsh_client_ui_primitives.Button, {
+    type: "button",
+    variant: "outline",
+    size: "sm",
+    onClick: () => {
+      setOpenError("");
+      void Promise.resolve().then(() => props.openFile?.(path)).catch(() => {
+        setOpenError("DSH \u65E0\u6CD5\u6253\u5F00\u6587\u4EF6\uFF0C\u8BF7\u68C0\u67E5\u4F1A\u8BDD\u5DE5\u4F5C\u533A\u8BBF\u95EE\u6743\u9650\u3002");
+      });
+    },
+    "aria-label": ariaLabel
+  }, label) : null;
+  if (htmlCanOpen && !props.block.isError && meta.status === "rendered") {
+    return (0, import_react.createElement)(
+      "div",
+      { className: "md-report-tool-row" },
+      (0, import_react.createElement)("span", null, summary),
+      meta.sourcePath ? (0, import_react.createElement)("span", null, `\u6E90 Markdown\uFF1A${meta.sourcePath}`) : null,
+      meta.previewPath ? (0, import_react.createElement)("span", null, `HTML \u6587\u4EF6\uFF1A${meta.previewPath}`) : null,
+      sourceCanOpen ? openWorkspaceFile(meta.sourceWorkspacePath, "\u9884\u89C8 Markdown", `\u5728\u53F3\u4FA7\u9884\u89C8 ${meta.title} \u7684 Markdown \u6E90\u6587\u4EF6`) : null,
+      openWorkspaceFile(meta.previewWorkspacePath, "\u9884\u89C8 HTML", `\u5728\u53F3\u4FA7\u9884\u89C8 ${meta.title} \u7684 HTML \u62A5\u544A`) ?? (0, import_react.createElement)("span", null, `\u9884\u89C8\u6587\u4EF6\uFF1A${meta.previewWorkspacePath}`),
+      body ? (0, import_react.createElement)(
+        "details",
+        null,
+        (0, import_react.createElement)("summary", null, "\u67E5\u770B\u6E32\u67D3\u6458\u8981"),
+        (0, import_react.createElement)("pre", null, body)
+      ) : null,
+      openError ? (0, import_react.createElement)("span", { role: "alert" }, openError) : null
+    );
+  }
+  return (0, import_react.createElement)(
+    "div",
+    { className: "md-report-tool-row", role: props.block.isError || meta.status === "storage-failed" ? "alert" : "status" },
+    (0, import_react.createElement)("span", null, summary),
+    meta.sourcePath ? (0, import_react.createElement)("span", null, `\u6E90 Markdown\uFF1A${meta.sourcePath}`) : null,
+    meta.previewPath ? (0, import_react.createElement)("span", null, `HTML \u6587\u4EF6\uFF1A${meta.previewPath}`) : null,
+    sourceCanOpen ? openWorkspaceFile(meta.sourceWorkspacePath, "\u9884\u89C8 Markdown", `\u5728\u53F3\u4FA7\u9884\u89C8 ${meta.title} \u7684 Markdown \u6E90\u6587\u4EF6`) : null,
+    meta.previewWorkspacePath && !htmlCanOpen ? (0, import_react.createElement)("span", { role: "alert" }, "HTML \u9884\u89C8\u8DEF\u5F84\u65E0\u6548\uFF0C\u672A\u6253\u5F00\u6587\u4EF6\u3002") : null,
+    body ? (0, import_react.createElement)(
+      "details",
+      null,
+      (0, import_react.createElement)("summary", null, props.block.isError ? "\u67E5\u770B\u9519\u8BEF\u8BE6\u60C5" : "\u67E5\u770B\u6E32\u67D3\u7ED3\u679C"),
+      (0, import_react.createElement)("pre", null, body)
+    ) : null
+  );
+}
+
+// plugins/hosts/dsh/src/client/index.ts
+var inject = ["slots"];
+function apply(ctx) {
+  ctx.effect(() => ctx.slots.inject(
+    "tool.call.toolview",
+    () => ctx.slots.register(
+      { name: "tool.call.toolview", key: "drender_render" },
+      (props) => (0, import_react2.createElement)(RenderToolRow, props)
+    )
+  ), "md-report: render result card");
+}
+return module.exports; } });