@dai_ming/plugin-deliverables 1.0.19 → 1.0.21

package/mcp-servers/deliverables.js

@@ -12,8 +12,10 @@
  *   CLAW_GATEWAY_API_KEY / OPENCLAW_GATEWAY_API_KEY — API key with access to /openclaw-gateway/be/*
  */
 
+var fs    = require("fs");
 var http  = require("http");
 var https = require("https");
+var path  = require("path");
 
 var GATEWAY_URL    = (process.env.CLAW_GATEWAY_URL        || "http://claw-gateway:8080").replace(/\/$/, "");
 var GATEWAY_PUBLIC = (process.env.CLAW_GATEWAY_PUBLIC_URL || GATEWAY_URL).replace(/\/$/, "");
@@ -68,6 +70,9 @@ function defaultExtensionForDeliverable(args) {
 
 function normalizeDeliverableFileName(args) {
   var fileName = trimString(args && args.file_name);
+  if (!fileName && trimString(args && args.file_path)) {
+    fileName = path.basename(trimString(args && args.file_path));
+  }
   if (!fileName) {
     fileName = "file";
   }
@@ -89,8 +94,8 @@ var TOOL_DEFS = [
     name: "upload_deliverable",
     description: [
       "将 AI 生成的内容（文章、游戏、图片等）上传为交付物，返回可分享的下载/预览链接。",
-      "单文件交付物：提供 content_text 或 content_base64。",
-      "多文件交付物（网页游戏/静态站点等）：必须优先提供 files 列表，每项包含 name（相对路径）和 content_text 或 content_base64，不要先打 zip。",
+      "单文件交付物：文本内容提供 content_text；PDF/PPT/图片/zip 等二进制文件优先提供 file_path，由工具读取文件并自动编码，不要手工复制 base64。",
+      "多文件交付物（网页游戏/静态站点等）：必须优先提供 files 列表，每项包含 name（相对路径）和 content_text、content_base64 或 file_path，不要先打 zip。",
       "静态多文件预览建议在根目录提供 index.html；需要单独启动端口/后端服务的项目不属于交付物预览范围，应走部署流程。",
       "返回的 download_url / preview_url 为长期可用链接。"
     ].join(" "),
@@ -124,7 +129,11 @@ var TOOL_DEFS = [
         },
         content_base64: {
           type: "string",
-          description: "Base64 编码的二进制内容（图片、zip 等），单文件时使用"
+          description: "Base64 编码的二进制内容，单文件时使用。二进制文件更推荐 file_path，避免复制/截断导致上传失败。"
+        },
+        file_path: {
+          type: "string",
+          description: "本地文件路径，推荐用于 PDF/PPT/图片/zip 等二进制交付物。工具会读取文件并自动生成 contentBase64。"
         },
         files: {
           type: "array",
@@ -134,7 +143,8 @@ var TOOL_DEFS = [
             properties: {
               name:           { type: "string", description: "文件在交付物目录内的相对路径，例如 index.html 或 assets/main.js" },
               content_text:   { type: "string", description: "文本内容" },
-              content_base64: { type: "string", description: "Base64 二进制内容" }
+              content_base64: { type: "string", description: "Base64 二进制内容" },
+              file_path:      { type: "string", description: "本地文件路径，工具会读取并自动编码" }
             },
             required: ["name"]
           }
@@ -229,9 +239,84 @@ function buildReplyMarkdown(opts) {
   return lines.join("\n");
 }
 
-// ─── Tool implementations ─────────────────────────────────────────────────────
+function normalizeBase64Content(value, label) {
+  var text = trimString(value);
+  if (!text) {
+    return "";
+  }
+  if (/^data:/i.test(text)) {
+    var commaIndex = text.indexOf(",");
+    if (commaIndex >= 0) {
+      text = text.slice(commaIndex + 1);
+    }
+  }
+  text = text.replace(/\s+/g, "");
+  if (!text) {
+    return "";
+  }
+  if (!/^[A-Za-z0-9+/]*={0,2}$/.test(text)) {
+    throw new Error("invalid base64 for " + label + ": contains non-base64 characters; use file_path for binary files");
+  }
+  var unpadded = text.replace(/=+$/, "");
+  if (unpadded.indexOf("=") >= 0) {
+    throw new Error("invalid base64 for " + label + ": padding must be at the end; use file_path for binary files");
+  }
+  var remainder = unpadded.length % 4;
+  if (remainder === 1) {
+    throw new Error("invalid base64 for " + label + ": truncated input; use file_path for binary files");
+  }
+  var padded = unpadded;
+  if (remainder === 2) {
+    padded += "==";
+  } else if (remainder === 3) {
+    padded += "=";
+  }
+  return Buffer.from(padded, "base64").toString("base64");
+}
 
-function uploadDeliverable(args) {
+function readFileAsBase64(filePath, label) {
+  var rawPath = trimString(filePath);
+  if (!rawPath) {
+    return "";
+  }
+  var resolvedPath = path.resolve(process.cwd(), rawPath);
+  var stat;
+  try {
+    stat = fs.statSync(resolvedPath);
+  } catch (err) {
+    throw new Error("cannot read " + label + " file_path " + rawPath + ": " + err.message);
+  }
+  if (!stat.isFile()) {
+    throw new Error("cannot read " + label + " file_path " + rawPath + ": not a file");
+  }
+  return fs.readFileSync(resolvedPath).toString("base64");
+}
+
+function buildContentPayload(entry, label) {
+  var filePath = trimString(entry && entry.file_path);
+  if (filePath) {
+    return {
+      contentText: "",
+      contentBase64: readFileAsBase64(filePath, label)
+    };
+  }
+  return {
+    contentText: (entry && entry.content_text) || "",
+    contentBase64: normalizeBase64Content(entry && entry.content_base64, label)
+  };
+}
+
+function deriveReleaseName() {
+  var release = process.env.botID || process.env.OPENCLAW_RELEASE || process.env.BOT_ID || "";
+  if (!release) {
+    var tok = process.env.OPENCLAW_GATEWAY_TOKEN || "";
+    if (tok.indexOf("oc-") === 0) release = tok.slice(3);
+  }
+  return release;
+}
+
+function buildUploadRequestBody(args) {
+  args = args || {};
   var normalizedFileName = normalizeDeliverableFileName(args);
   var body = {
     resourceId: args.resource_id,
@@ -239,34 +324,35 @@ function uploadDeliverable(args) {
     userId:     args.user_id,
     type:       args.type,
     fileName:   normalizedFileName,
-    release:    ""  // overwritten below after release name derivation
+    release:    deriveReleaseName()
   };
 
   if (args.files && args.files.length > 0) {
-    body.files = args.files.map(function(f) {
+    body.files = args.files.map(function(f, index) {
+      var payload = buildContentPayload(f, "files[" + index + "] " + f.name);
       return {
         name:          f.name,
-        contentText:   f.content_text   || "",
-        contentBase64: f.content_base64 || ""
+        contentText:   payload.contentText,
+        contentBase64: payload.contentBase64
       };
     });
   } else {
-    body.contentText   = args.content_text   || "";
-    body.contentBase64 = args.content_base64 || "";
+    var singlePayload = buildContentPayload(args, "content_base64");
+    body.contentText   = singlePayload.contentText;
+    body.contentBase64 = singlePayload.contentBase64;
   }
 
-  // Derive release name:
-  // 1) botID (runtime env, e.g. "user-xxx") is preferred
-  // 2) OPENCLAW_RELEASE / BOT_ID (compat)
-  // 3) fallback to stripping "oc-" prefix from OPENCLAW_GATEWAY_TOKEN
-  var release = process.env.botID || process.env.OPENCLAW_RELEASE || process.env.BOT_ID || "";
-  if (!release) {
-    var tok = process.env.OPENCLAW_GATEWAY_TOKEN || "";
-    if (tok.indexOf("oc-") === 0) release = tok.slice(3);
-  }
-  body.release = release;
+  return body;
+}
+
+// ─── Tool implementations ─────────────────────────────────────────────────────
 
-  return httpRequest("POST", "/openclaw-gateway/be/deliverables", body).then(function(resp) {
+function uploadDeliverable(args) {
+  return Promise.resolve().then(function() {
+    return buildUploadRequestBody(args);
+  }).then(function(body) {
+    return httpRequest("POST", "/openclaw-gateway/be/deliverables", body);
+  }).then(function(resp) {
     var d = resp.body.data || resp.body;
     // Prefer backend-aware previewUrl returned by gateway (OSS/output/link).
     // Fallback to legacy gateway preview endpoint for compatibility.
@@ -315,7 +401,7 @@ function handleMessage(msg) {
       send({ jsonrpc: "2.0", id: id, result: {
         protocolVersion: "2024-11-05",
         capabilities: { tools: {} },
-        serverInfo: { name: "deliverables", version: "1.0.2" }
+        serverInfo: { name: "deliverables", version: "1.0.3" }
       }});
       return Promise.resolve();
 
@@ -347,12 +433,24 @@ function handleMessage(msg) {
   }
 }
 
-var rl = require("readline").createInterface({ input: process.stdin, terminal: false });
-rl.on("line", function(line) {
-  if (!line.trim()) return;
-  var msg;
-  try { msg = JSON.parse(line); } catch(e) { return; }
-  handleMessage(msg).catch(function(err) {
-    process.stderr.write("[deliverables] unhandled error: " + err.message + "\n");
+function startMCPServer() {
+  var rl = require("readline").createInterface({ input: process.stdin, terminal: false });
+  rl.on("line", function(line) {
+    if (!line.trim()) return;
+    var msg;
+    try { msg = JSON.parse(line); } catch(e) { return; }
+    handleMessage(msg).catch(function(err) {
+      process.stderr.write("[deliverables] unhandled error: " + err.message + "\n");
+    });
   });
-});
+}
+
+module.exports.__test = {
+  buildContentPayload: buildContentPayload,
+  buildUploadRequestBody: buildUploadRequestBody,
+  normalizeBase64Content: normalizeBase64Content
+};
+
+if (require.main === module) {
+  startMCPServer();
+}

package/openclaw-plugin.json

@@ -1,6 +1,6 @@
 {
   "name": "plugin-deliverables",
-  "version": "1.0.19",
+  "version": "1.0.21",
   "npm_package": "@dai_ming/plugin-deliverables",
   "description": "Deliverables plugin: MCP server + skill + AGENTS rules for AI-generated file uploads",
   "mcp_servers": {

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.19",
+  "version": "1.0.21",
   "skills": ["./skills"],
   "configSchema": {
     "type": "object",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dai_ming/plugin-deliverables",
-  "version": "1.0.19",
+  "version": "1.0.21",
   "description": "OpenClaw deliverables plugin — upload AI-generated files to OSS and return shareable preview/download links",
   "keywords": [
     "openclaw",
@@ -10,6 +10,9 @@
   ],
   "license": "MIT",
   "main": "index.js",
+  "scripts": {
+    "test": "node test/index.test.js && node test/mcp-server.test.js"
+  },
   "files": [
     "INSTALL.md",
     "index.js",
@@ -17,7 +20,8 @@
     "openclaw-plugin.json",
     "mcp-servers/",
     "skills/",
-    "agents-rules/"
+    "agents-rules/",
+    "test/"
   ],
   "openclaw": {
     "extensions": [

package/skills/deliverables/SKILL.md

@@ -34,9 +34,16 @@ description: 上传AI生成的文件到交付物系统，返回可分享的预
 | `type` | 根据内容选择：`article`/`game`/`image`/`video`/`ppt`/`zip`/`link` | `article` |
 | `file_name` | 有意义的文件名，单文件必须含扩展名；若用户未指定文档格式，默认用 `.md` | `report-2026.html` |
 | `content_text` | 文件的完整文本内容（HTML/Markdown等） | `<html>...</html>` |
+| `file_path` | PDF/PPT/图片/zip 等二进制文件的本地路径，推荐使用，避免手工复制 base64 | `output/sample.pdf` |
 
 > **直接对话（direct chat）时**：`group_id` 填 `conversation_id`，`user_id` 填 `owner_id`。
 
+## 二进制文件上传（强制）
+
+- PDF、PPT、图片、视频、zip 等二进制文件必须优先传 `file_path`，不要把 `base64` 命令输出复制到 `content_base64`。
+- `file_path` 指向你已经写入 `output/` 的文件，例如 `output/sample.pdf`；上传工具会读取文件并自动编码。
+- 如果上传工具返回错误，必须修正参数后重试，或明确告诉用户上传失败；禁止编造 OSS、下载或预览链接。
+
 ## 多文件（游戏）
 
 type 为 `game` 时，使用 `files` 数组替代 `content_text`：

package/test/index.test.js

@@ -0,0 +1,100 @@
+"use strict";
+
+const assert = require("assert");
+
+process.env.CLAW_GATEWAY_PUBLIC_URL = "https://claw-gateway.csagentai.com";
+
+const plugin = require("../index.js");
+const {
+  deliverableTypeForPath,
+  extractFileReferencesFromText,
+  findUntrustedOSSDeliverableURL,
+  isDeliverableLinkLine,
+  isTrustedDeliverableURL,
+  splitDeliverableMessage,
+} = plugin.__test;
+
+const gatewayURL =
+  "https://claw-gateway.csagentai.com/openclaw-gateway/output/user/res/uuid/sample.pdf";
+const bogusOSSURL =
+  "https://palz-deliverable.oss-cn-shanghai.aliyuncs.com/user/res/sample.pdf?OSSAccessKeyId=fake";
+
+assert.strictEqual(isTrustedDeliverableURL(gatewayURL), true);
+assert.strictEqual(isTrustedDeliverableURL(bogusOSSURL), false);
+assert.strictEqual(
+  isDeliverableLinkLine(`预览链接：[点击预览](${gatewayURL})`),
+  true,
+);
+assert.strictEqual(
+  isDeliverableLinkLine(`预览链接：[点击预览](${bogusOSSURL})`),
+  false,
+);
+
+const split = splitDeliverableMessage(
+  [
+    "我生成了一个 1 页 PDF。",
+    "",
+    `预览链接：[点击预览](${gatewayURL})`,
+    `下载链接：[点击下载](${gatewayURL})`,
+  ].join("\n"),
+);
+assert.ok(split);
+assert.strictEqual(split.primaryLinkUrl, gatewayURL);
+
+assert.strictEqual(
+  splitDeliverableMessage(
+    [
+      "我生成了一个 1 页 PDF。",
+      "",
+      `预览链接：[点击预览](${bogusOSSURL})`,
+      `下载链接：[点击下载](${bogusOSSURL})`,
+    ].join("\n"),
+  ),
+  null,
+);
+assert.strictEqual(
+  findUntrustedOSSDeliverableURL(
+    [
+      "我生成了一个 1 页 PDF。",
+      "",
+      `预览链接：[点击预览](${bogusOSSURL})`,
+    ].join("\n"),
+  ),
+  bogusOSSURL,
+);
+assert.strictEqual(
+  findUntrustedOSSDeliverableURL(
+    [
+      "我生成了一个大文件。",
+      "",
+      `预览链接：[点击预览](${gatewayURL})`,
+      `下载链接：[点击下载](${bogusOSSURL})`,
+    ].join("\n"),
+  ),
+  "",
+);
+
+const multiSplit = splitDeliverableMessage(
+  [
+    "已生成多个文件。",
+    "",
+    `预览链接：[设计文档](${gatewayURL})`,
+    `下载链接：[测试报告](https://claw-gateway.csagentai.com/openclaw-gateway/output/user/res/uuid/report.md)`,
+  ].join("\n"),
+);
+assert.ok(multiSplit);
+assert.strictEqual(multiSplit.linkUrls.length, 2);
+
+const refs = extractFileReferencesFromText(
+  "设计文档：`game-brief.md`\n开发路径：/data/workspace-lobster_abc/output/app/index.html\n相对路径 output/report.pdf",
+);
+assert.deepStrictEqual(
+  refs.map((ref) => ref.value),
+  ["/data/workspace-lobster_abc/output/app/index.html", "game-brief.md", "output/report.pdf"],
+);
+
+assert.strictEqual(deliverableTypeForPath("intro.pdf", false), "article");
+assert.strictEqual(deliverableTypeForPath("cover.png", false), "image");
+assert.strictEqual(deliverableTypeForPath("slides.pptx", false), "ppt");
+assert.strictEqual(deliverableTypeForPath("dist.zip", false), "zip");
+assert.strictEqual(deliverableTypeForPath("/data/workspace-lobster_abc/output/site", true), "game");

package/test/mcp-server.test.js

@@ -0,0 +1,44 @@
+"use strict";
+
+const assert = require("assert");
+const fs = require("fs");
+const os = require("os");
+const path = require("path");
+
+const {
+  buildUploadRequestBody,
+  normalizeBase64Content,
+} = require("../mcp-servers/deliverables.js").__test;
+
+assert.strictEqual(
+  normalizeBase64Content("SGVs\nbG8", "content_base64"),
+  Buffer.from("Hello").toString("base64"),
+);
+assert.strictEqual(
+  normalizeBase64Content("data:application/pdf;base64,JVBERi0xLjM", "content_base64"),
+  Buffer.from("%PDF-1.3").toString("base64"),
+);
+assert.throws(
+  () => normalizeBase64Content("SGVsb", "content_base64"),
+  /truncated input/,
+);
+
+const tmpDir = fs.mkdtempSync(path.join(os.tmpdir(), "deliverables-mcp-"));
+const pdfPath = path.join(tmpDir, "sample.pdf");
+const pdfBytes = Buffer.from("%PDF-1.3\nsample\n", "utf8");
+fs.writeFileSync(pdfPath, pdfBytes);
+
+const body = buildUploadRequestBody({
+  resource_id: "res-1",
+  group_id: "group-1",
+  user_id: "user-1",
+  type: "article",
+  file_name: "sample.pdf",
+  file_path: pdfPath,
+  content_base64: "not-used",
+});
+
+assert.strictEqual(body.resourceId, "res-1");
+assert.strictEqual(body.fileName, "sample.pdf");
+assert.strictEqual(body.contentText, "");
+assert.strictEqual(body.contentBase64, pdfBytes.toString("base64"));