paperclip-github-plugin 0.8.9 → 0.8.11

package/README.md

@@ -227,7 +227,7 @@ The plugin exposes GitHub workflow tools to Paperclip agents, including:
 
 - repository-scoped search for issues and pull requests
 - issue reads, comment reads, comment writes, metadata updates, and `assign_to_current_user` assignment to the saved token owner
-- pull request creation, reads, updates, changed-file inspection, and CI-check inspection
+- pull request creation, reads, updates, changed-file inspection, CI-check inspection, and asset upload for PR visual evidence
 - review-thread reads, replies, resolve and unresolve actions, and `request_pull_request_reviewers` reviewer requests
 - organization-level GitHub Project search/listing and pull-request-to-project association
 
@@ -272,6 +272,34 @@ Current host caveat: on authenticated Paperclip deployments, the Paperclip host
 
 Because the KPI attribution endpoint is a native plugin JSON route rather than a plugin tool, authenticated agent runs can still call it directly with `PAPERCLIP_API_KEY` even while that host bug blocks the GitHub Sync tool surface.
 
+### Pull request asset upload
+
+For PRs that need durable assets in the description, agents can call the `upload_pull_request_asset` tool. The tool accepts a PR target plus `fileName` and either `contentBase64` or a `dataUrl`; optional fields include `label`, `alt` (an alias for image alt text), `caption`, `mimeType`, and `artifactBranch`. Common MIME types are inferred from filenames, including images and PDFs. Unknown types are stored as `application/octet-stream`. Assets are limited to 10 MiB.
+
+The plugin writes the asset to a non-merge artifact branch named `paperclip-artifacts-pr-<number>` by default, stores it under `assets/pr-<number>/<head-sha>/`, and returns immutable raw GitHub URLs plus Markdown suitable for a PR description. Images return image Markdown; PDFs and other files return normal Markdown links.
+
+Authenticated agent runs that cannot call plugin tools can post the same JSON payload to `/api/plugins/paperclip-github-plugin/api/pull-request-assets` with `Authorization: Bearer ${PAPERCLIP_API_KEY}`. The native plugin route is agent-authenticated by the Paperclip host before worker dispatch.
+
+Example:
+
+```bash
+contentBase64="$(base64 -w0 /tmp/review-report.pdf)"
+payload="$(jq -n \
+  --arg repository paperclipai/example-repo \
+  --argjson pullRequestNumber 21 \
+  --arg fileName review-report.pdf \
+  --arg label 'Review report PDF' \
+  --arg contentBase64 "$contentBase64" \
+  '{repository:$repository,pullRequestNumber:$pullRequestNumber,fileName:$fileName,label:$label,contentBase64:$contentBase64,mimeType:"application/pdf"}')"
+
+curl -X POST "${PAPERCLIP_API_URL%/}/api/plugins/paperclip-github-plugin/api/pull-request-assets" \
+  -H "content-type: application/json" \
+  -H "authorization: Bearer ${PAPERCLIP_API_KEY}" \
+  -d "${payload}"
+```
+
+The response body contains `asset.markdown`, `asset.rawUrl`, `asset.artifactBranch`, `asset.path`, and `asset.commitSha`.
+
 ### Issue link API route
 
 Authenticated agent runs can link the current Paperclip issue to a GitHub issue or pull request by posting to `/api/plugins/paperclip-github-plugin/api/issue-link`. This is useful after creating a PR with `gh` in a repository that is not mapped to a Paperclip project.

package/dist/manifest.js

@@ -523,6 +523,58 @@ var GITHUB_AGENT_TOOLS = [
       }
     }
   },
+  {
+    name: "upload_pull_request_asset",
+    displayName: "Upload Pull Request Asset",
+    description: "Upload a PR-visible asset such as an image, PDF, log, archive, or report to a non-merge artifact branch and return durable markdown that can be embedded in the PR body.",
+    parametersSchema: {
+      type: "object",
+      additionalProperties: false,
+      required: ["fileName"],
+      allOf: [pullRequestTargetSchema],
+      anyOf: [
+        { required: ["contentBase64"] },
+        { required: ["dataUrl"] }
+      ],
+      properties: {
+        repository: repositoryProperty,
+        pullRequestNumber: pullRequestNumberProperty,
+        paperclipIssueId: paperclipIssueIdProperty,
+        fileName: {
+          type: "string",
+          description: "Asset filename. The plugin sanitizes it and preserves a safe extension."
+        },
+        label: {
+          type: "string",
+          description: "Human-readable link text for the returned Markdown. Defaults to the sanitized filename."
+        },
+        alt: {
+          type: "string",
+          description: "Backward-compatible alias for label, useful as image alt text."
+        },
+        caption: {
+          type: "string",
+          description: "Optional human-facing caption returned with the uploaded asset metadata."
+        },
+        contentBase64: {
+          type: "string",
+          description: "Base64-encoded asset bytes. Assets are limited to 10 MiB."
+        },
+        dataUrl: {
+          type: "string",
+          description: "Alternative base64 data URL input such as data:application/pdf;base64,... or data:image/png;base64,... ."
+        },
+        mimeType: {
+          type: "string",
+          description: "Optional MIME type such as application/pdf or image/png. If omitted, the plugin infers common types from fileName and otherwise uses application/octet-stream."
+        },
+        artifactBranch: {
+          type: "string",
+          description: "Optional artifact branch name. Defaults to paperclip-artifacts-pr-<pullRequestNumber>."
+        }
+      }
+    }
+  },
   {
     name: "link_github_item",
     displayName: "Link GitHub Item",
@@ -582,12 +634,15 @@ var COMPANY_METRIC_API_ROUTE_URL_PATH = `/api/plugins/${GITHUB_SYNC_PLUGIN_ID}/a
 var ISSUE_LINK_API_ROUTE_KEY = "link-github-item";
 var ISSUE_LINK_API_ROUTE_PATH = "/issue-link";
 var ISSUE_LINK_API_ROUTE_URL_PATH = `/api/plugins/${GITHUB_SYNC_PLUGIN_ID}/api${ISSUE_LINK_API_ROUTE_PATH}`;
+var PULL_REQUEST_ASSET_API_ROUTE_KEY = "upload-pull-request-asset";
+var PULL_REQUEST_ASSET_API_ROUTE_PATH = "/pull-request-assets";
+var PULL_REQUEST_ASSET_API_ROUTE_URL_PATH = `/api/plugins/${GITHUB_SYNC_PLUGIN_ID}/api${PULL_REQUEST_ASSET_API_ROUTE_PATH}`;
 
 // src/manifest.ts
 var require2 = createRequire(import.meta.url);
 var packageJson = require2("../package.json");
 var SCHEDULE_TICK_CRON = "* * * * *";
-var MANIFEST_VERSION = "0.8.9"?.trim() || typeof packageJson.version === "string" && packageJson.version.trim() || process.env.npm_package_version?.trim() || "0.0.0-dev";
+var MANIFEST_VERSION = "0.8.11"?.trim() || typeof packageJson.version === "string" && packageJson.version.trim() || process.env.npm_package_version?.trim() || "0.0.0-dev";
 var manifest = {
   id: GITHUB_SYNC_PLUGIN_ID,
   apiVersion: 1,
@@ -666,6 +721,13 @@ var manifest = {
       path: ISSUE_LINK_API_ROUTE_PATH,
       auth: "agent",
       capability: "api.routes.register"
+    },
+    {
+      routeKey: PULL_REQUEST_ASSET_API_ROUTE_KEY,
+      method: "POST",
+      path: PULL_REQUEST_ASSET_API_ROUTE_PATH,
+      auth: "agent",
+      capability: "api.routes.register"
     }
   ],
   tools: GITHUB_AGENT_TOOLS,

package/dist/ui/index.js

@@ -366,7 +366,7 @@ import {
   usePluginToast
 } from "@paperclipai/plugin-sdk/ui";
 
-// node_modules/.pnpm/@ungap+structured-clone@1.3.0/node_modules/@ungap/structured-clone/esm/types.js
+// node_modules/.pnpm/@ungap+structured-clone@1.3.1/node_modules/@ungap/structured-clone/esm/types.js
 var VOID = -1;
 var PRIMITIVE = 0;
 var ARRAY = 1;
@@ -378,8 +378,20 @@ var SET = 6;
 var ERROR = 7;
 var BIGINT = 8;
 
-// node_modules/.pnpm/@ungap+structured-clone@1.3.0/node_modules/@ungap/structured-clone/esm/deserialize.js
+// node_modules/.pnpm/@ungap+structured-clone@1.3.1/node_modules/@ungap/structured-clone/esm/deserialize.js
 var env = typeof self === "object" ? self : globalThis;
+var guard = (name2, init) => {
+  switch (name2) {
+    case "Function":
+    case "SharedWorker":
+    case "Worker":
+    case "eval":
+    case "setInterval":
+    case "setTimeout":
+      throw new TypeError("unable to deserialize " + name2);
+  }
+  return new env[name2](init);
+};
 var deserializer = ($2, _) => {
   const as = (out, index2) => {
     $2.set(index2, out);
@@ -425,7 +437,7 @@ var deserializer = ($2, _) => {
       }
       case ERROR: {
         const { name: name2, message } = value;
-        return as(new env[name2](message), index2);
+        return as(guard(name2, message), index2);
       }
       case BIGINT:
         return as(BigInt(value), index2);
@@ -438,13 +450,13 @@ var deserializer = ($2, _) => {
         return as(new DataView(buffer), value);
       }
     }
-    return as(new env[type](value), index2);
+    return as(guard(type, value), index2);
   };
   return unpair;
 };
 var deserialize = (serialized) => deserializer(/* @__PURE__ */ new Map(), serialized)(0);
 
-// node_modules/.pnpm/@ungap+structured-clone@1.3.0/node_modules/@ungap/structured-clone/esm/serialize.js
+// node_modules/.pnpm/@ungap+structured-clone@1.3.1/node_modules/@ungap/structured-clone/esm/serialize.js
 var EMPTY = "";
 var { toString } = {};
 var { keys } = Object;
@@ -577,7 +589,7 @@ var serialize = (value, { json, lossy } = {}) => {
   return serializer(!(json || lossy), !!json, /* @__PURE__ */ new Map(), _)(value), _;
 };
 
-// node_modules/.pnpm/@ungap+structured-clone@1.3.0/node_modules/@ungap/structured-clone/esm/index.js
+// node_modules/.pnpm/@ungap+structured-clone@1.3.1/node_modules/@ungap/structured-clone/esm/index.js
 var esm_default = typeof structuredClone === "function" ? (
   /* c8 ignore start */
   (any, options) => options && ("json" in options || "lossy" in options) ? deserialize(serialize(any, options)) : structuredClone(any)
@@ -11984,7 +11996,7 @@ var urlAttributes = {
   ]
 };
 
-// node_modules/.pnpm/react-markdown@10.1.0_@types+react@19.2.14_react@19.2.5/node_modules/react-markdown/lib/index.js
+// node_modules/.pnpm/react-markdown@10.1.0_@types+react@19.2.14_react@19.2.6/node_modules/react-markdown/lib/index.js
 import { Fragment, jsx, jsxs } from "react/jsx-runtime";
 import { useEffect, useState } from "react";
 
@@ -19140,7 +19152,7 @@ function isUint8Array2(value) {
   );
 }
 
-// node_modules/.pnpm/react-markdown@10.1.0_@types+react@19.2.14_react@19.2.5/node_modules/react-markdown/lib/index.js
+// node_modules/.pnpm/react-markdown@10.1.0_@types+react@19.2.14_react@19.2.6/node_modules/react-markdown/lib/index.js
 var changelog = "https://github.com/remarkjs/react-markdown/blob/main/changelog.md";
 var emptyPlugins = [];
 var emptyRemarkRehypeOptions = { allowDangerousHtml: true };