npm - @dai_ming/plugin-deliverables - Versions diffs - 1.0.21 → 1.1.0 - Mend

@dai_ming/plugin-deliverables 1.0.21 → 1.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (9) hide show

package/INSTALL.md +12 -200
package/README.md +22 -227
package/index.js +290 -3
package/openclaw-plugin.json +2 -14
package/openclaw.plugin.json +1 -1
package/package.json +5 -8
package/mcp-servers/deliverables.js +0 -456
package/test/index.test.js +0 -100
package/test/mcp-server.test.js +0 -44

package/index.js CHANGED Viewed

@@ -85,6 +85,67 @@ const RUNTIME_DELIVERABLES_GUIDANCE = [
   "- 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.",
 ].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", "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";
 }
@@ -565,6 +626,172 @@ 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 "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}`;
 }
@@ -1222,6 +1449,7 @@ function splitDeliverableMessage(text) {
   const linkLines = [];
   const linkUrls = [];
+  const linkItems = [];
   for (let i = firstLinkIndex; i < lines.length; i += 1) {
     const line = lines[i];
     if (isLinksHeading(line)) {
@@ -1234,6 +1462,7 @@ function splitDeliverableMessage(text) {
         const url = extractDeliverableURL(normalizedLine);
         if (url) {
           linkUrls.push(url);
+          linkItems.push({ line: normalizedLine, url });
         }
       }
     }
@@ -1249,10 +1478,53 @@ function splitDeliverableMessage(text) {
     summary,
     links,
     linkUrls,
+    linkItems,
     primaryLinkUrl: linkUrls.length > 0 ? linkUrls[0] : "",
+    fileLinkUrl: selectPalzFileURL(linkItems),
   };
 }
+function extractDeliverableIdentity(rawURL) {
+  if (!isString(rawURL) || !rawURL.trim()) {
+    return "";
+  }
+  let parsed;
+  try {
+    parsed = new URL(rawURL.trim());
+  } catch (_err) {
+    return "";
+  }
+  if (!DELIVERABLE_GATEWAY_PATH_RE.test(parsed.pathname)) {
+    return "";
+  }
+  const parts = parsed.pathname.split("/").filter(Boolean);
+  const uuidRe = /^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$/iu;
+  for (const part of parts) {
+    if (uuidRe.test(part)) {
+      return part.toLowerCase();
+    }
+  }
+  return parsed.href;
+}
+function selectPalzFileURL(linkItems) {
+  if (!Array.isArray(linkItems) || linkItems.length === 0) {
+    return "";
+  }
+  const identities = new Set();
+  for (const item of linkItems) {
+    const identity = extractDeliverableIdentity(item && item.url);
+    if (identity) {
+      identities.add(identity);
+    }
+  }
+  if (identities.size !== 1) {
+    return "";
+  }
+  const download = linkItems.find((item) => /下载链接/u.test(String((item && item.line) || "")));
+  return (download && download.url) || linkItems[0].url || "";
+}
 function cloneBody(body, content, suffix) {
   const next = {};
   Object.keys(body).forEach((key) => {
@@ -1308,6 +1580,7 @@ function shouldSplitPalzPayload(body) {
       summary: cachedSummary,
       links: split.links,
       primaryLinkUrl: split.primaryLinkUrl,
+      fileLinkUrl: split.fileLinkUrl,
     };
   }
   return split;
@@ -1403,14 +1676,15 @@ function installPalzFetchPatch(api) {
     }
     const summaryBody = cloneBody(parsed, split.summary, "__summary");
-    const linksBody = split.primaryLinkUrl && (!Array.isArray(split.linkUrls) || split.linkUrls.length === 1)
-      ? cloneBodyAsFileLink(parsed, split.primaryLinkUrl, "__links")
+    const fileLinkUrl = split.fileLinkUrl || "";
+    const linksBody = fileLinkUrl
+      ? cloneBodyAsFileLink(parsed, fileLinkUrl, "__links")
       : cloneBody(parsed, split.links, "__links");
     const summaryBodyStr = JSON.stringify(summaryBody);
     const linksBodyStr = JSON.stringify(linksBody);
     api.logger.info?.(
-      `[plugin-deliverables] split deliverable reply injected by plugin-deliverables target=${String(parsed.conversation_id || "")} summaryMsgId=${String(summaryBody.msg_id || "")} linksMsgId=${String(linksBody.msg_id || "")} linksMode=${split.primaryLinkUrl ? "file_url" : "text"}`,
+      `[plugin-deliverables] split deliverable reply injected by plugin-deliverables target=${String(parsed.conversation_id || "")} summaryMsgId=${String(summaryBody.msg_id || "")} linksMsgId=${String(linksBody.msg_id || "")} linksMode=${fileLinkUrl ? "file_url" : "text"}`,
     );
     api.logger.info?.(
       `[plugin-deliverables] palz summary request body_length=${summaryBodyStr.length}\n  request_body=${summaryBodyStr}`,
@@ -1458,6 +1732,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,
     }));
@@ -1508,6 +1794,7 @@ plugin.__test = {
   isDeliverableLinkLine,
   isOSSLikeURL,
   isTrustedDeliverableURL,
+  selectPalzFileURL,
   splitDeliverableMessage,
 };

package/openclaw-plugin.json CHANGED Viewed

@@ -1,20 +1,8 @@
 {
   "name": "plugin-deliverables",
-  "version": "1.0.21",
+  "version": "1.1.0",
   "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 CHANGED Viewed

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

package/package.json CHANGED Viewed

@@ -1,27 +1,24 @@
 {
   "name": "@dai_ming/plugin-deliverables",
-  "version": "1.0.21",
-  "description": "OpenClaw deliverables plugin — upload AI-generated files to OSS and return shareable preview/download links",
+  "version": "1.1.0",
+  "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": [