@dai_ming/plugin-deliverables 1.1.1 → 1.1.3

package/agents-rules/deliverables.md

@@ -56,28 +56,31 @@ Tool name note:
 1. Create content under current agent workspace `output/` directory first (for example `output/report.md`), then call the deliverables upload tool exposed in this session.
 2. If you need to use the `write` tool, the target path MUST be inside `output/`. Never write deliverable files to the workspace root.
 3. If you already wrote the file to the wrong place, move/copy it into `output/` before finalizing the task and before describing the saved path to the user.
-4. For binary deliverables such as PDF, PPT, images, video, or zip files, pass `file_path` pointing at the file under `output/`; do not paste shell output or partial base64 into `content_base64`.
-5. If the user asks for PDF, upload the generated `.pdf` file with `type=pdf`; do not substitute HTML or Markdown unless PDF generation truly failed and you clearly say so.
-6. If the upload tool returns an error, retry with a valid `file_path` or report the upload failure. Never invent OSS, preview, or download URLs.
-7. If format is HTML, prefer `type=article` and file name ends with `.html`.
-8. Every single-file deliverable MUST use a file name with an explicit extension.
-9. If format is markdown/text, use `type=article` and `.md`/`.txt`.
-10. If the user did not specify a document/text format, default to Markdown and use a `.md` file name.
-11. For multi-file deliverables (game/site), you MUST prefer `type=game` with `files[]`, keep files as a folder structure, and do NOT zip before upload unless the user explicitly asks for a zip package.
-12. Static multi-file game/site deliverables SHOULD include a root `index.html` so the preview link can open the homepage directly.
-13. If a generated project requires starting a separate backend service, custom port, database, or long-running process to work, do NOT pretend the deliverables preview can run it. Tell the user that deliverables preview only supports static output, and that runtime projects need deployment/ingress instead.
-14. After successful upload, the final assistant message MUST start with 1-2 short sentences in your own words, briefly describing what you generated for the user.
-15. For content deliverables such as articles, documents, reports, and PDFs, add 3-5 concise bullets after the intro summarizing the actual sections, highlights, or conclusions. Do not reply with only a one-sentence upload notice.
-16. The intro and bullets must be based on the actual deliverable content/request, not a fixed sentence like `交付物已上传成功，可直接在线预览或下载。`
-17. If tool result contains `reply_markdown`, append that field verbatim after your intro and content bullets on the following lines.
-18. Otherwise final reply MUST include Markdown links (short label + full URL target):
+4. For simple text PDFs, call `deliverables__upload_deliverable` directly with `type=pdf`, a `.pdf` `file_name`, and `content_text`; the tool renders a basic PDF without installing dependencies.
+5. For existing binary deliverables such as rich PDFs, PPT, images, video, or zip files, pass `file_path` pointing at the file under `output/`; do not paste shell output or partial base64 into `content_base64`.
+6. Never run `pip install`, `npm install`, `apt-get`, or similar dependency installation just to create a PDF. Use built-in tools or the PDF `content_text` fallback; if rich PDF generation is unavailable, say so clearly.
+7. If the user asks for PDF, upload a `.pdf` deliverable with `type=pdf`; do not substitute HTML or Markdown unless PDF generation truly failed and you clearly say so.
+8. If the upload tool returns an error, retry with valid parameters or report the upload failure. Never invent OSS, preview, or download URLs.
+9. If format is HTML, prefer `type=article` and file name ends with `.html`.
+10. Local file names or relative paths such as `review.html` and `output/report.md` are not links. Do not use `type=link` for them; upload them with `file_path` or `content_text`.
+11. Every single-file deliverable MUST use a file name with an explicit extension.
+12. If format is markdown/text, use `type=article` and `.md`/`.txt`.
+13. If the user did not specify a document/text format, default to Markdown and use a `.md` file name.
+14. For multi-file deliverables (game/site), you MUST prefer `type=game` with `files[]`, keep files as a folder structure, and do NOT zip before upload unless the user explicitly asks for a zip package.
+15. Static multi-file game/site deliverables SHOULD include a root `index.html` so the preview link can open the homepage directly.
+16. If a generated project requires starting a separate backend service, custom port, database, or long-running process to work, do NOT pretend the deliverables preview can run it. Tell the user that deliverables preview only supports static output, and that runtime projects need deployment/ingress instead.
+17. After successful upload, the final assistant message MUST start with 1-2 short sentences in your own words, briefly describing what you generated for the user.
+18. For content deliverables such as articles, documents, reports, and PDFs, add 3-5 concise bullets after the intro summarizing the actual sections, highlights, or conclusions. Do not reply with only a one-sentence upload notice.
+19. The intro and bullets must be based on the actual deliverable content/request, not a fixed sentence like `交付物已上传成功，可直接在线预览或下载。`
+20. If tool result contains `reply_markdown`, append that field verbatim after your intro and content bullets on the following lines.
+21. Otherwise final reply MUST include Markdown links (short label + full URL target):
    `预览链接：[点击预览](<full_url>)`
    `下载链接：[点击下载](<full_url>)`
-19. For multi-file/game deliverables, if the tool gives directory-style output, the second line may be:
+22. For multi-file/game deliverables, if the tool gives directory-style output, the second line may be:
    `文件列表：[查看目录](<full_url>)`
    Keep that format instead of forcing a zip link.
-20. Do NOT only say "已保存到工作空间".
-21. Do NOT append workspace path or a raw URL block after the Markdown links.
+23. Do NOT only say "已保存到工作空间".
+24. Do NOT append workspace path or a raw URL block after the Markdown links.
 
 ### Exception
 

package/index.js

@@ -26,6 +26,7 @@ const DELIVERABLE_LINK_LABEL_RE =
 const INTERNAL_ABSOLUTE_PATH_RE =
   /(?:\/data\/workspace-[^\s`"'<>，。；：、)）\]}]+|\/home\/node\/\.openclaw\/workspace(?:-[A-Za-z0-9_.-]+)?\/[^\s`"'<>，。；：、)）\]}]+)/gu;
 const INLINE_FILE_REF_RE = /`([^`\n]{1,512}\.[A-Za-z0-9]{1,16})`/gu;
+const MARKDOWN_FILE_LINK_RE = /\[[^\]\n]{0,200}\]\(([^)\s]+?\.[A-Za-z0-9]{1,16})\)/gu;
 const OUTPUT_RELATIVE_REF_RE = /(?:^|[\s(:：])((?:\.\/)?output\/[^\s`"'<>，。；：、)）\]}]+\.[A-Za-z0-9]{1,16})/gu;
 const FILE_EXTENSION_RE = /\.[A-Za-z0-9]{1,16}$/u;
 const TEXT_EXTENSIONS = new Set([
@@ -78,7 +79,10 @@ const RUNTIME_DELIVERABLES_GUIDANCE = [
   "",
   "- These rules apply to the main agent and all subagents.",
   "- 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`.",
+  "- For simple text PDF deliverables, call `deliverables__upload_deliverable` with `type: \"pdf\"`, a `.pdf` `file_name`, and `content_text`; the tool will render a basic PDF without installing dependencies.",
+  "- For existing binary deliverables such as rich PDFs, 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`.",
+  "- Never use `type: \"link\"` for local files, relative paths, or generated files such as `review.html`; use `file_path`, `content_text`, or `files` so the file is uploaded.",
+  "- Never install PDF libraries or other packages at runtime just to create a deliverable. Use built-in tools or the PDF `content_text` fallback; if a rich PDF renderer is unavailable, say so clearly.",
   "- 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.",
@@ -112,7 +116,7 @@ const UPLOAD_DELIVERABLE_TOOL = {
       type: {
         type: "string",
         enum: ["article", "game", "zip", "image", "video", "ppt", "pdf", "link"],
-        description: "交付物类型。若使用 file_path 且未准确判断，可由插件按文件扩展名兜底。",
+        description: "交付物类型。link 仅用于外部 http(s) URL；本地/生成文件必须使用 file_path、content_text 或 files。",
       },
       file_name: {
         type: "string",
@@ -195,6 +199,15 @@ function isURLLike(value) {
   return /^[a-z][a-z0-9+.-]*:\/\//i.test(String(value || ""));
 }
 
+function isHTTPURLLike(value) {
+  try {
+    const parsed = new URL(String(value || "").trim());
+    return (parsed.protocol === "http:" || parsed.protocol === "https:") && !!parsed.hostname;
+  } catch (_err) {
+    return false;
+  }
+}
+
 function fileExtension(filePath) {
   return path.extname(stripTrailingPathPunctuation(filePath)).toLowerCase();
 }
@@ -371,6 +384,9 @@ function extractFileReferencesFromText(text) {
   for (const match of normalized.matchAll(INLINE_FILE_REF_RE)) {
     add(match[0], match[1], "inline");
   }
+  for (const match of normalized.matchAll(MARKDOWN_FILE_LINK_RE)) {
+    add(match[0], match[1], "markdown-link");
+  }
   for (const match of normalized.matchAll(OUTPUT_RELATIVE_REF_RE)) {
     add(match[1], match[1], "relative");
   }
@@ -579,6 +595,31 @@ function deriveReleaseName() {
   return release;
 }
 
+function normalizeBareUserID(value) {
+  let raw = trimString(value);
+  if (!raw) {
+    return "";
+  }
+  if (raw.indexOf("user_") === 0 && raw.indexOf("_lobster_") > 0) {
+    raw = raw.slice("user_".length, raw.indexOf("_lobster_"));
+  } else if (raw.indexOf("user-") === 0 || raw.indexOf("user_") === 0) {
+    raw = raw.slice("user-".length);
+  }
+  return raw;
+}
+
+function userIDFromRelease(release) {
+  return normalizeBareUserID(release);
+}
+
+function userIDFromResourceID(resourceID) {
+  const raw = trimString(resourceID);
+  if (raw.indexOf("user_") !== 0 && raw.indexOf("user-") !== 0) {
+    return "";
+  }
+  return normalizeBareUserID(raw);
+}
+
 function httpJSONRequest(method, requestPath, body) {
   return new Promise((resolve, reject) => {
     let parsed;
@@ -671,6 +712,155 @@ function defaultExtensionForDeliverable(args) {
   }
 }
 
+function normalizePDFSourceText(contentText, fallbackTitle) {
+  const text = trimString(contentText) || trimString(fallbackTitle) || "PDF deliverable";
+  return text
+    .replace(/\r\n/g, "\n")
+    .replace(/\r/g, "\n")
+    .split("\n")
+    .map((line) =>
+      line
+        .replace(/^#{1,6}\s+/, "")
+        .replace(/\*\*([^*]+)\*\*/g, "$1")
+        .replace(/`([^`]+)`/g, "$1")
+        .replace(/^\s*[-*]\s+/, "- ")
+        .trimEnd(),
+    )
+    .join("\n")
+    .slice(0, 20000);
+}
+
+function visualWidth(text) {
+  let width = 0;
+  for (const ch of String(text || "")) {
+    width += ch.charCodeAt(0) > 0xff ? 2 : 1;
+  }
+  return width;
+}
+
+function wrapPDFTextLine(line, maxWidth) {
+  const input = String(line || "");
+  if (input.length === 0) {
+    return [""];
+  }
+  const out = [];
+  let current = "";
+  for (const ch of input) {
+    if (current && visualWidth(current + ch) > maxWidth) {
+      out.push(current);
+      current = ch;
+    } else {
+      current += ch;
+    }
+  }
+  if (current) {
+    out.push(current);
+  }
+  return out;
+}
+
+function utf16BEHex(text) {
+  const input = String(text || "");
+  const bytes = [0xfe, 0xff];
+  for (let i = 0; i < input.length; i += 1) {
+    const code = input.charCodeAt(i);
+    bytes.push((code >> 8) & 0xff, code & 0xff);
+  }
+  return Buffer.from(bytes).toString("hex").toUpperCase();
+}
+
+function buildPDFObjects(objects) {
+  const chunks = ["%PDF-1.4\n%\xE2\xE3\xCF\xD3\n"];
+  const offsets = [0];
+  let length = Buffer.byteLength(chunks[0], "utf8");
+  for (const obj of objects) {
+    const body = `${obj.id} 0 obj\n${obj.body}\nendobj\n`;
+    offsets[obj.id] = length;
+    chunks.push(body);
+    length += Buffer.byteLength(body, "utf8");
+  }
+  const xrefOffset = length;
+  const maxID = objects.reduce((max, obj) => Math.max(max, obj.id), 0);
+  const xref = ["xref\n", `0 ${maxID + 1}\n`, "0000000000 65535 f \n"];
+  for (let id = 1; id <= maxID; id += 1) {
+    xref.push(`${String(offsets[id] || 0).padStart(10, "0")} 00000 n \n`);
+  }
+  xref.push(
+    "trailer\n",
+    `<< /Size ${maxID + 1} /Root 1 0 R >>\n`,
+    "startxref\n",
+    `${xrefOffset}\n`,
+    "%%EOF\n",
+  );
+  return Buffer.from(chunks.join("") + xref.join(""), "utf8");
+}
+
+function createBasicTextPDF(contentText, fileName) {
+  const normalized = normalizePDFSourceText(contentText, fileName);
+  const wrappedLines = [];
+  for (const line of normalized.split("\n")) {
+    wrappedLines.push(...wrapPDFTextLine(line, 72));
+  }
+  const linesPerPage = 44;
+  const pages = [];
+  for (let i = 0; i < wrappedLines.length; i += linesPerPage) {
+    pages.push(wrappedLines.slice(i, i + linesPerPage));
+  }
+  if (pages.length === 0) {
+    pages.push(["PDF deliverable"]);
+  }
+
+  const pageIDs = pages.map((_, idx) => 3 + idx);
+  const fontID = 3 + pages.length;
+  const cidFontID = fontID + 1;
+  const contentStartID = cidFontID + 1;
+  const objects = [
+    { id: 1, body: "<< /Type /Catalog /Pages 2 0 R >>" },
+    {
+      id: 2,
+      body: `<< /Type /Pages /Kids [${pageIDs.map((id) => `${id} 0 R`).join(" ")}] /Count ${pages.length} >>`,
+    },
+  ];
+
+  pages.forEach((pageLines, idx) => {
+    const contentID = contentStartID + idx;
+    objects.push({
+      id: pageIDs[idx],
+      body: `<< /Type /Page /Parent 2 0 R /MediaBox [0 0 595 842] /Resources << /ProcSet [/PDF /Text] /Font << /F1 ${fontID} 0 R >> >> /Contents ${contentID} 0 R >>`,
+    });
+  });
+
+  objects.push(
+    {
+      id: fontID,
+      body: `<< /Type /Font /Subtype /Type0 /BaseFont /STSong-Light /Encoding /UniGB-UCS2-H /DescendantFonts [${cidFontID} 0 R] >>`,
+    },
+    {
+      id: cidFontID,
+      body:
+        "<< /Type /Font /Subtype /CIDFontType0 /BaseFont /STSong-Light /CIDSystemInfo << /Registry (Adobe) /Ordering (GB1) /Supplement 2 >> /DW 1000 >>",
+    },
+  );
+
+  pages.forEach((pageLines, idx) => {
+    const streamLines = ["BT", "/F1 12 Tf", "50 790 Td", "16 TL"];
+    pageLines.forEach((line) => {
+      if (line) {
+        streamLines.push(`<${utf16BEHex(line)}> Tj`);
+      }
+      streamLines.push("T*");
+    });
+    streamLines.push("ET");
+    const stream = `${streamLines.join("\n")}\n`;
+    objects.push({
+      id: contentStartID + idx,
+      body: `<< /Length ${Buffer.byteLength(stream, "utf8")} >>\nstream\n${stream}endstream`,
+    });
+  });
+
+  return buildPDFObjects(objects);
+}
+
 function normalizeDeliverableFileName(args, fallbackName) {
   let fileName = trimString(args && args.file_name) || trimString(fallbackName) || "file";
   if (trimString(args && args.type) === "link") {
@@ -733,16 +923,23 @@ function buildNativeUploadRequestBody(args) {
   }
 
   const body = {
-    resourceId: args.resource_id,
-    groupId: args.group_id,
-    userId: args.user_id,
+    resourceId: trimString(args && args.resource_id),
+    groupId: trimString(args && args.group_id) || trimString(args && args.resource_id),
+    userId:
+      normalizeBareUserID(args && args.user_id) ||
+      userIDFromResourceID(args && args.resource_id) ||
+      userIDFromRelease(deriveReleaseName()),
     release: deriveReleaseName(),
   };
 
   if (fileCandidate) {
     const stat = safeStat(fileCandidate.path);
     const isDirectory = !!(stat && stat.isDirectory());
-    body.type = trimString(args.type) || deliverableTypeForPath(fileCandidate.path, isDirectory);
+    const requestedType = trimString(args.type);
+    body.type =
+      requestedType === "link"
+        ? deliverableTypeForPath(fileCandidate.path, isDirectory)
+        : requestedType || deliverableTypeForPath(fileCandidate.path, isDirectory);
     body.fileName = normalizeDeliverableFileName(args, fileCandidate.fileName);
     if (isDirectory) {
       const files = collectDirectoryFiles(fileCandidate.path);
@@ -762,11 +959,29 @@ function buildNativeUploadRequestBody(args) {
   body.fileName = normalizeDeliverableFileName(args, "");
   const files = normalizeNativeToolFiles(args && args.files);
   if (files.length > 0) {
+    if (body.type === "link") {
+      body.type = "game";
+    }
     body.files = files;
     return { body, isDirectory: true };
   }
-  body.contentText = (args && (args.content_text || args.contentText)) || "";
-  body.contentBase64 = (args && (args.content_base64 || args.contentBase64)) || "";
+  const contentText = (args && (args.content_text || args.contentText)) || "";
+  const contentBase64 = (args && (args.content_base64 || args.contentBase64)) || "";
+  if (body.type === "link") {
+    if (trimString(contentText) || trimString(contentBase64)) {
+      body.type = deliverableTypeForPath(body.fileName, false);
+    } else if (!isHTTPURLLike(body.fileName)) {
+      throw new Error(
+        "type=link requires file_name to be an absolute http(s) URL; use file_path or content_text for local/generated files",
+      );
+    }
+  }
+  if (body.type === "pdf" && trimString(contentText) && !trimString(contentBase64)) {
+    body.contentBase64 = createBasicTextPDF(contentText, body.fileName).toString("base64");
+  } else {
+    body.contentText = contentText;
+    body.contentBase64 = contentBase64;
+  }
   return { body, isDirectory: false };
 }
 
@@ -819,8 +1034,8 @@ async function uploadCandidate(candidate, body) {
   }
   const requestBody = {
     resourceId,
-    groupId: payloadGroupId(body),
-    userId: payloadUserId(body),
+    groupId: payloadGroupId(body) || resourceId,
+    userId: normalizeBareUserID(payloadUserId(body)) || userIDFromResourceID(resourceId) || userIDFromRelease(deriveReleaseName()),
     release: deriveReleaseName(),
     type: deliverableTypeForPath(candidate.path, stat.isDirectory()),
     fileName: candidate.fileName || path.basename(candidate.path),
@@ -1794,6 +2009,8 @@ const plugin = {
 };
 
 plugin.__test = {
+  buildNativeUploadRequestBody,
+  createBasicTextPDF,
   deliverableTypeForPath,
   extractFileReferencesFromText,
   extractDeliverableURL,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dai_ming/plugin-deliverables",
-  "version": "1.1.1",
+  "version": "1.1.3",
   "description": "OpenClaw deliverables native plugin — upload AI-generated files to OSS and return shareable preview/download links",
   "keywords": [
     "openclaw",

package/skills/deliverables/SKILL.md

@@ -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`/`pdf`/`zip`/`link` | `article` |
+| `type` | 根据内容选择：`article`/`game`/`image`/`video`/`ppt`/`pdf`/`zip`；`link` 仅用于外部 `http(s)` URL | `article` |
 | `file_name` | 有意义的文件名，单文件必须含扩展名；若用户未指定文档格式，默认用 `.md` | `report-2026.html` |
 | `content_text` | 文件的完整文本内容（HTML/Markdown等） | `<html>...</html>` |
 | `file_path` | PDF/PPT/图片/zip 等二进制文件的本地路径，推荐使用，避免手工复制 base64 | `output/sample.pdf` |
@@ -44,6 +44,7 @@ description: 上传AI生成的文件到交付物系统，返回可分享的预
 - `file_path` 指向你已经写入 `output/` 的文件，例如 `output/sample.pdf`；上传工具会读取文件并自动编码。
 - 用户要求 PDF 时，必须上传生成好的 `.pdf` 文件，`type` 使用 `pdf`；不要只返回 HTML/Markdown 作为替代格式。
 - 如果上传工具返回错误，必须修正参数后重试，或明确告诉用户上传失败；禁止编造 OSS、下载或预览链接。
+- 本地文件名或相对路径（例如 `review.html`、`output/report.md`）不是外部链接，不能用 `type=link`；必须用 `file_path` 或 `content_text` 上传。
 
 ## 多文件（游戏）