@dai_ming/plugin-deliverables 1.0.22 → 1.1.1

package/index.js

@@ -53,6 +53,7 @@ const TEXT_EXTENSIONS = new Set([
 const IMAGE_EXTENSIONS = new Set([".apng", ".avif", ".bmp", ".gif", ".ico", ".jpeg", ".jpg", ".png", ".svg", ".webp"]);
 const VIDEO_EXTENSIONS = new Set([".avi", ".m4v", ".mkv", ".mov", ".mp4", ".mpeg", ".mpg", ".webm"]);
 const PPT_EXTENSIONS = new Set([".ppt", ".pptx"]);
+const PDF_EXTENSIONS = new Set([".pdf"]);
 const ARCHIVE_EXTENSIONS = new Set([".7z", ".gz", ".rar", ".tar", ".tgz", ".zip"]);
 const IGNORED_PATH_PARTS = new Set([
   ".git",
@@ -76,15 +77,77 @@ const RUNTIME_DELIVERABLES_GUIDANCE = [
   "## Deliverables Runtime Guard (HARD CONSTRAINT)",
   "",
   "- These rules apply to the main agent and all subagents.",
-  "- When the user asks for a document, article, report, HTML page, Markdown file, PPT, image, archive, game, or any other file deliverable, you MUST create it under the current workspace `output/` directory and upload it with `deliverables__upload_deliverable`.",
+  "- When the user asks for a document, article, report, PDF, HTML page, Markdown file, PPT, image, archive, game, or any other file deliverable, you MUST create it under the current workspace `output/` directory and upload it with `deliverables__upload_deliverable`.",
   "- For binary deliverables such as PDF, PPT, images, video, or zip files, pass `file_path` to `deliverables__upload_deliverable` after writing the file under `output/`; do not paste command output or partial base64 into `content_base64`.",
+  "- If the user asks for PDF, upload the generated `.pdf` as `type: \"pdf\"`; do not substitute HTML or Markdown unless PDF generation truly failed and you clearly say so.",
   "- Every single-file deliverable must use a file name with an explicit extension. If the user did not specify a document/text format, default to Markdown and use a `.md` file name.",
   "- Do not use direct message attachments to deliver generated files. This includes the message tool attachment fields such as `media`, `path`, `filePath`, `buffer`, `attachment`, or similar file-carrying fields.",
   "- Do not emit `MEDIA:` file references for user-facing deliverables. Deliverable links must come from the deliverables upload tool instead.",
   "- If the deliverables upload tool returns an error, retry with a valid `file_path` or explain the upload failure; never invent or rewrite OSS/download URLs.",
-  "- After a successful upload, reply with a substantive content summary before the links. For documents/articles/reports, prefer 1 short intro plus 3-6 concise bullets covering key sections, highlights, or findings, then preserve the Markdown links returned by the deliverables tool.",
+  "- After a successful upload, reply with a substantive content summary before the links. For documents/articles/reports/PDFs, include 1 short intro plus 3-5 concise bullets covering the actual sections, highlights, or findings; never respond with only a generic one-sentence upload notice.",
 ].join("\n");
 
+const UPLOAD_DELIVERABLE_TOOL = {
+  name: "deliverables__upload_deliverable",
+  description: [
+    "将 AI 生成的内容或 output/ 下的文件上传为交付物，返回可分享的下载/预览链接。",
+    "二进制文件优先传 file_path；文本单文件可传 content_text；多文件静态站点/游戏传 files。",
+    "返回的 reply_markdown 可直接回显给用户。",
+  ].join(" "),
+  inputSchema: {
+    type: "object",
+    properties: {
+      resource_id: {
+        type: "string",
+        description: "当前聊天框/会话的唯一 ID（必填）。",
+      },
+      group_id: {
+        type: "string",
+        description: "当前会话所属的群聊 ID（可选）。",
+      },
+      user_id: {
+        type: "string",
+        description: "请求交付物的用户 ID（可选）。",
+      },
+      type: {
+        type: "string",
+        enum: ["article", "game", "zip", "image", "video", "ppt", "pdf", "link"],
+        description: "交付物类型。若使用 file_path 且未准确判断，可由插件按文件扩展名兜底。",
+      },
+      file_name: {
+        type: "string",
+        description: "用户可见文件名。单文件必须带扩展名；未指定文档格式时默认 .md。",
+      },
+      file_path: {
+        type: "string",
+        description: "output/ 下已生成文件或目录的路径。二进制交付物优先使用此字段。",
+      },
+      content_text: {
+        type: "string",
+        description: "文本内容（Markdown、HTML 等）。",
+      },
+      content_base64: {
+        type: "string",
+        description: "Base64 编码的二进制内容。",
+      },
+      files: {
+        type: "array",
+        description: "多文件列表。每项包含 name 以及 content_text 或 content_base64。",
+        items: {
+          type: "object",
+          properties: {
+            name: { type: "string", description: "相对路径，例如 index.html 或 assets/main.js" },
+            content_text: { type: "string", description: "文本内容" },
+            content_base64: { type: "string", description: "Base64 二进制内容" },
+          },
+          required: ["name"],
+        },
+      },
+    },
+    required: ["resource_id", "type", "file_name"],
+  },
+};
+
 function isString(value) {
   return typeof value === "string";
 }
@@ -154,6 +217,9 @@ function deliverableTypeForPath(filePath, isDirectory) {
   if (PPT_EXTENSIONS.has(ext)) {
     return "ppt";
   }
+  if (PDF_EXTENSIONS.has(ext)) {
+    return "pdf";
+  }
   if (ARCHIVE_EXTENSIONS.has(ext)) {
     return "zip";
   }
@@ -565,6 +631,174 @@ function httpJSONRequest(method, requestPath, body) {
   });
 }
 
+function looksLikeHTMLContent(contentText) {
+  const text = trimString(contentText).toLowerCase();
+  if (!text) {
+    return false;
+  }
+  if (text.indexOf("<!doctype html") === 0 || text.indexOf("<html") === 0) {
+    return true;
+  }
+  return (
+    text.indexOf("<head") >= 0 ||
+    text.indexOf("<body") >= 0 ||
+    text.indexOf("<main") >= 0 ||
+    text.indexOf("<section") >= 0 ||
+    text.indexOf("<article") >= 0 ||
+    text.indexOf("<style") >= 0 ||
+    text.indexOf("<script") >= 0
+  );
+}
+
+function defaultExtensionForDeliverable(args) {
+  const deliverableType = trimString(args && args.type);
+  switch (deliverableType) {
+    case "article":
+    case "game":
+      return looksLikeHTMLContent(args && args.content_text) ? ".html" : ".md";
+    case "zip":
+      return ".zip";
+    case "ppt":
+      return ".pptx";
+    case "pdf":
+      return ".pdf";
+    case "image":
+      return ".png";
+    case "video":
+      return ".mp4";
+    default:
+      return "";
+  }
+}
+
+function normalizeDeliverableFileName(args, fallbackName) {
+  let fileName = trimString(args && args.file_name) || trimString(fallbackName) || "file";
+  if (trimString(args && args.type) === "link") {
+    return fileName;
+  }
+  if (Array.isArray(args && args.files) && args.files.length > 0) {
+    return fileName;
+  }
+  if (trimString(args && args.file_path)) {
+    return fileName;
+  }
+  if (hasFileExtension(fileName)) {
+    return fileName;
+  }
+  const ext = defaultExtensionForDeliverable(args);
+  return ext ? fileName + ext : fileName;
+}
+
+function buildReplyMarkdown(opts) {
+  const previewURL = opts.previewURL || "";
+  const downloadURL = opts.downloadURL || "";
+  const deliverableType = opts.type || "";
+  const isDirectory = !!opts.isDirectory;
+  const lines = [];
+  if (previewURL) {
+    lines.push(`预览链接：[点击预览](${previewURL})`);
+  }
+  if (downloadURL) {
+    if (isDirectory || deliverableType === "game") {
+      lines.push(`文件列表：[查看目录](${downloadURL})`);
+    } else {
+      lines.push(`下载链接：[点击下载](${downloadURL})`);
+    }
+  }
+  if (lines.length === 0) {
+    return "交付物已上传成功。";
+  }
+  return lines.join("\n");
+}
+
+function normalizeNativeToolFiles(files) {
+  if (!Array.isArray(files)) {
+    return [];
+  }
+  return files.map((file) => ({
+    name: file.name,
+    contentText: file.contentText || file.content_text || "",
+    contentBase64: file.contentBase64 || file.content_base64 || "",
+  }));
+}
+
+function buildNativeUploadRequestBody(args) {
+  const rawFilePath = trimString(args && args.file_path);
+  let fileCandidate = null;
+  if (rawFilePath) {
+    fileCandidate = resolveFileReference({ raw: rawFilePath, value: rawFilePath, kind: "tool" });
+    if (!fileCandidate) {
+      throw new Error(`file_path is not readable or not under an OpenClaw workspace: ${rawFilePath}`);
+    }
+  }
+
+  const body = {
+    resourceId: args.resource_id,
+    groupId: args.group_id,
+    userId: args.user_id,
+    release: deriveReleaseName(),
+  };
+
+  if (fileCandidate) {
+    const stat = safeStat(fileCandidate.path);
+    const isDirectory = !!(stat && stat.isDirectory());
+    body.type = trimString(args.type) || deliverableTypeForPath(fileCandidate.path, isDirectory);
+    body.fileName = normalizeDeliverableFileName(args, fileCandidate.fileName);
+    if (isDirectory) {
+      const files = collectDirectoryFiles(fileCandidate.path);
+      if (files.length === 0) {
+        throw new Error(`directory has no uploadable files: ${fileCandidate.fileName}`);
+      }
+      body.files = files;
+    } else if (isTextLikeFile(fileCandidate.path)) {
+      body.contentText = fs.readFileSync(fileCandidate.path, "utf8");
+    } else {
+      body.contentBase64 = fs.readFileSync(fileCandidate.path).toString("base64");
+    }
+    return { body, isDirectory };
+  }
+
+  body.type = trimString(args && args.type);
+  body.fileName = normalizeDeliverableFileName(args, "");
+  const files = normalizeNativeToolFiles(args && args.files);
+  if (files.length > 0) {
+    body.files = files;
+    return { body, isDirectory: true };
+  }
+  body.contentText = (args && (args.content_text || args.contentText)) || "";
+  body.contentBase64 = (args && (args.content_base64 || args.contentBase64)) || "";
+  return { body, isDirectory: false };
+}
+
+async function uploadDeliverable(args) {
+  const { body, isDirectory } = buildNativeUploadRequestBody(args || {});
+  const response = await httpJSONRequest("POST", "/openclaw-gateway/be/deliverables", body);
+  const data = response.data || response;
+  const previewURL = data.previewUrl || `${gatewayPublicURL()}/openclaw-gateway/preview/${data.uuid}`;
+  const downloadURL = data.downloadUrl || previewURL;
+  const replyMarkdown = buildReplyMarkdown({
+    previewURL,
+    downloadURL,
+    type: body.type,
+    isDirectory,
+  });
+  return {
+    uuid: data.uuid,
+    backend: data.backend || "",
+    download_url: downloadURL,
+    preview_url: previewURL,
+    expire_at: data.expireAt,
+    reply_markdown: replyMarkdown,
+    message: replyMarkdown,
+  };
+}
+
+function nativeToolResult(result) {
+  return {
+    content: [{ type: "text", text: JSON.stringify(result, null, 2) }],
+  };
+}
+
 function uploadCacheKey(candidate, resourceId) {
   return `${resourceId || ""}:${candidate.path}:${candidate.mtimeMs || 0}:${candidate.size || 0}`;
 }
@@ -1505,6 +1739,18 @@ const plugin = {
   register(api) {
     installPalzFetchPatch(api);
 
+    if (api && typeof api.registerTool === "function") {
+      api.registerTool({
+        name: UPLOAD_DELIVERABLE_TOOL.name,
+        description: UPLOAD_DELIVERABLE_TOOL.description,
+        parameters: UPLOAD_DELIVERABLE_TOOL.inputSchema,
+        async execute(_callId, params) {
+          cacheUploadSummary(params);
+          return nativeToolResult(await uploadDeliverable(params || {}));
+        },
+      });
+    }
+
     api.on("before_prompt_build", async () => ({
       prependSystemContext: RUNTIME_DELIVERABLES_GUIDANCE,
     }));

package/openclaw-plugin.json

@@ -1,20 +1,8 @@
 {
   "name": "plugin-deliverables",
-  "version": "1.0.22",
+  "version": "1.1.1",
   "npm_package": "@dai_ming/plugin-deliverables",
-  "description": "Deliverables plugin: MCP server + skill + AGENTS rules for AI-generated file uploads",
-  "mcp_servers": {
-    "deliverables": {
-      "script": "mcp-servers/deliverables.js",
-      "command": "node",
-      "env": {
-        "CLAW_GATEWAY_URL": "${CLAW_GATEWAY_URL}",
-        "CLAW_GATEWAY_PUBLIC_URL": "${CLAW_GATEWAY_PUBLIC_URL}",
-        "CLAW_GATEWAY_API_KEY": "${CLAW_GATEWAY_API_KEY}",
-        "OPENCLAW_GATEWAY_API_KEY": "${OPENCLAW_GATEWAY_API_KEY}"
-      }
-    }
-  },
+  "description": "Deliverables plugin: native upload tool + skill + AGENTS rules for AI-generated file uploads",
   "skills": {
     "deliverables": "skills/deliverables/SKILL.md"
   },

package/openclaw.plugin.json

@@ -2,7 +2,7 @@
   "id": "plugin-deliverables",
   "name": "Deliverables",
   "description": "Deliverables runtime guard for upload-first file delivery with Palz split-send diagnostics.",
-  "version": "1.0.22",
+  "version": "1.1.1",
   "skills": ["./skills"],
   "configSchema": {
     "type": "object",

package/package.json

@@ -1,27 +1,24 @@
 {
   "name": "@dai_ming/plugin-deliverables",
-  "version": "1.0.22",
-  "description": "OpenClaw deliverables plugin — upload AI-generated files to OSS and return shareable preview/download links",
+  "version": "1.1.1",
+  "description": "OpenClaw deliverables native plugin — upload AI-generated files to OSS and return shareable preview/download links",
   "keywords": [
     "openclaw",
     "plugin",
-    "deliverables",
-    "mcp"
+    "deliverables"
   ],
   "license": "MIT",
   "main": "index.js",
   "scripts": {
-    "test": "node test/index.test.js && node test/mcp-server.test.js"
+    "test": "node test/index.test.js"
   },
   "files": [
     "INSTALL.md",
     "index.js",
     "openclaw.plugin.json",
     "openclaw-plugin.json",
-    "mcp-servers/",
     "skills/",
-    "agents-rules/",
-    "test/"
+    "agents-rules/"
   ],
   "openclaw": {
     "extensions": [

package/skills/deliverables/SKILL.md

@@ -5,7 +5,7 @@ description: 上传AI生成的文件到交付物系统，返回可分享的预
 
 # 文件交付规则（强制）
 
-当你生成了文件内容（文章、文档、介绍、攻略、HTML页面、Markdown、游戏、图片等），**必须**调用交付物上传工具，不得把文件内容直接粘贴在消息里。
+当你生成了文件内容（文章、文档、介绍、攻略、PDF、HTML页面、Markdown、游戏、图片等），**必须**调用交付物上传工具，不得把文件内容直接粘贴在消息里。
 
 ## 工具名说明（强制）
 
@@ -31,7 +31,7 @@ description: 上传AI生成的文件到交付物系统，返回可分享的预
 | `resource_id` | 消息元数据中的 `resource_id` 字段 | `user_xxx_lobster_yyy` |
 | `group_id` | 消息元数据中的 `group_id` 或 `conversation_id` | `group_abc123` |
 | `user_id` | 消息元数据中的 `sender_id` 或 `owner_id` | `cbb0fab9...` |
-| `type` | 根据内容选择：`article`/`game`/`image`/`video`/`ppt`/`zip`/`link` | `article` |
+| `type` | 根据内容选择：`article`/`game`/`image`/`video`/`ppt`/`pdf`/`zip`/`link` | `article` |
 | `file_name` | 有意义的文件名，单文件必须含扩展名；若用户未指定文档格式，默认用 `.md` | `report-2026.html` |
 | `content_text` | 文件的完整文本内容（HTML/Markdown等） | `<html>...</html>` |
 | `file_path` | PDF/PPT/图片/zip 等二进制文件的本地路径，推荐使用，避免手工复制 base64 | `output/sample.pdf` |
@@ -42,6 +42,7 @@ description: 上传AI生成的文件到交付物系统，返回可分享的预
 
 - PDF、PPT、图片、视频、zip 等二进制文件必须优先传 `file_path`，不要把 `base64` 命令输出复制到 `content_base64`。
 - `file_path` 指向你已经写入 `output/` 的文件，例如 `output/sample.pdf`；上传工具会读取文件并自动编码。
+- 用户要求 PDF 时，必须上传生成好的 `.pdf` 文件，`type` 使用 `pdf`；不要只返回 HTML/Markdown 作为替代格式。
 - 如果上传工具返回错误，必须修正参数后重试，或明确告诉用户上传失败；禁止编造 OSS、下载或预览链接。
 
 ## 多文件（游戏）
@@ -64,9 +65,10 @@ files: [
 ## 上传成功后
 
 优先规则：
-- 最终消息必须先用你自己的话写 1-2 句简短介绍，粗略说明你生成了什么内容、包含哪些重点。
-- 这句介绍必须基于实际产物内容，不要使用固定模板，例如：`交付物已上传成功，可直接在线预览或下载。`
-- 如果工具结果里有 `reply_markdown`，把它原样放在这句介绍后面，不要改写其中的链接。
+- 最终消息必须先用你自己的话写 1-2 句简短介绍，说明你生成了什么内容。
+- 对文章、文档、报告、PDF 等内容型交付物，介绍后必须补充 3-5 条内容要点，概括实际章节、重点信息或结论；不要只写一句“已上传/已生成”。
+- 介绍和要点必须基于实际产物内容，不要使用固定模板，例如：`交付物已上传成功，可直接在线预览或下载。`
+- 如果工具结果里有 `reply_markdown`，把它原样放在内容要点后面，不要改写其中的链接。
 
 否则只发给用户：
 - 预览链接（`preview_url`，必须用 Markdown 链接格式）