@buildinternet/uploads 0.3.0 → 0.4.0

package/README.md

@@ -1,6 +1,6 @@
 # @buildinternet/uploads
 
-CLI and client for **uploads.sh** — upload files, get public URLs, and produce GitHub-ready markdown. Successor to the R2 scripts in `buildinternet-skills/github-screenshots`.
+CLI and client for **uploads.sh** — upload files, get public URLs, and produce GitHub-ready markdown.
 
 ## CLI
 

package/dist/cli.js

@@ -19,7 +19,7 @@ Config (first match wins, per key):
   environment         UPLOADS_API_URL, UPLOADS_TOKEN, UPLOADS_WORKSPACE
   --env-file <path>
   $BUILDINTERNET_CONFIG
-  ~/.config/buildinternet/config   (shared with github-screenshots)
+  ~/.config/buildinternet/config
 
 Workspace (within config layers):
   --workspace, -w     override — global (before command) or per-command (after)

package/dist/client.d.ts

@@ -1,4 +1,13 @@
 import type { UploadsClientConfig } from "./config.js";
+/** Allowlisted object provenance (maps to X-Uploads-Meta-* on put). */
+export type ProvenanceInput = {
+    client?: string;
+    "client-version"?: string;
+    "source-name"?: string;
+    optimized?: "0" | "1";
+    frame?: string;
+    "keep-exif"?: "0" | "1";
+};
 export interface PutOptions {
     key?: string;
     contentType?: string;
@@ -6,6 +15,8 @@ export interface PutOptions {
     repo?: string;
     ref?: string;
     deriveRepoFromGit?: boolean;
+    /** Stored as R2 custom metadata; echoed on put/head. */
+    provenance?: ProvenanceInput;
 }
 export interface ListOptions {
     prefix?: string;
@@ -18,6 +29,7 @@ export interface PutResult {
     url: string;
     size: number;
     contentType: string;
+    metadata?: Record<string, string>;
 }
 export interface ListItem {
     key: string;
@@ -35,6 +47,7 @@ export interface HeadResult {
     size: number;
     contentType: string;
     uploaded?: string;
+    metadata?: Record<string, string>;
 }
 export interface DeleteResult {
     key: string;

package/dist/client.js

@@ -117,9 +117,16 @@ export function createUploadsClient(config) {
                     deriveRepoFromGit: opts.deriveRepoFromGit,
                 }));
             const contentType = opts.contentType ?? inferContentType(opts.filename);
+            const headers = { "Content-Type": contentType };
+            if (opts.provenance) {
+                for (const [k, v] of Object.entries(opts.provenance)) {
+                    if (v !== undefined && v !== "")
+                        headers[`X-Uploads-Meta-${k}`] = v;
+                }
+            }
             const result = await request("PUT", `${filesBase(config)}/${encodeKeyPath(key)}`, {
                 body,
-                headers: { "Content-Type": contentType },
+                headers,
             });
             if (result.url == null) {
                 throw new UploadsError("upload succeeded but workspace has no publicBaseUrl", "NO_PUBLIC_URL", 201);

package/dist/commands.js

@@ -11,6 +11,7 @@ import { resolveRepo, resolveCurrentPullRequest, execRunner, upsertAttachmentsCo
 import { resolvePutPrefix } from "./destinations.js";
 import { optimizeImageForUpload, rewriteKeyExtension, } from "./optimize.js";
 import { applyFrame, resolveFrameId } from "./frame.js";
+import { buildCliProvenance } from "./provenance.js";
 // --- put ---
 const PUT_HELP = `uploads put <file> [options]
 
@@ -230,6 +231,12 @@ export async function runAttach(ctx, args, help = false, run = execRunner) {
             filename: prepared.filename,
             key: ghAttachmentKey(target, prepared.filename),
             contentType: prepared.optimized ? prepared.contentType : contentTypeOverride,
+            provenance: buildCliProvenance({
+                sourceName,
+                optimized: prepared.optimized,
+                frameId: prepared.frame?.framed ? prepared.frame.frameId : undefined,
+                keepExif: optimizeOpts.keepExif === true,
+            }),
         });
         results.push({
             ...result,
@@ -363,6 +370,12 @@ export async function runPut(ctx, args, help = false, run = execRunner) {
         ref: flagString(parsed.flags, "--ref") ?? defaults.ref,
         contentType: prepared.optimized ? prepared.contentType : contentTypeOverride,
         deriveRepoFromGit: !noGit,
+        provenance: buildCliProvenance({
+            sourceName,
+            optimized: prepared.optimized,
+            frameId: prepared.frame?.framed ? prepared.frame.frameId : undefined,
+            keepExif: optimizeOpts.keepExif === true,
+        }),
     });
     const markdown = buildMarkdown(result.url, { alt, width });
     const optimizeMeta = {

package/dist/index.d.ts

@@ -3,7 +3,8 @@ export { sanitizeKeySegment, sha256Short, deriveRepoFromGit, buildScreenshotKey
 export { BUILTIN_DESTINATIONS, isBuiltinDestination, keyMatchesDestination, resolveDestinationRoot, resolvePutPrefix, type BuiltinDestinationId, } from "./destinations.js";
 export { DEFAULT_API_URL, DEFAULT_WORKSPACE, UPLOADS_CONFIG_KEYS, defaultConfigPath, resolveConfigPath, loadConfigFile, loadEnvFile, resolveApiUrl, resolveConfig, describeConfigSources, redactToken, writeConfigKeys, configValuesFromClient, putDefaultsToConfigValues, resolvePutDefaults, mergePutDefaults, workspaceFromToken, workspaceMismatch, type UploadsClientConfig, type ResolvedConfig, type WorkspaceSource, type ConfigValueSource, type ConfigSources, type UploadsConfigKey, type UploadsConfigValues, type PutDefaults, } from "./config.js";
 export { UploadsError, type UploadsErrorCode } from "./errors.js";
-export { createUploadsClient, type UploadsClient, type PutOptions, type ListOptions, type PutResult, type ListItem, type ListResult, type HeadResult, type DeleteResult, type HealthResult, type UsageResult, type ReconcileResult, type PurgeExpiredResult, type PurgeExpiredResponse, } from "./client.js";
+export { createUploadsClient, type UploadsClient, type PutOptions, type ProvenanceInput, type ListOptions, type PutResult, type ListItem, type ListResult, type HeadResult, type DeleteResult, type HealthResult, type UsageResult, type ReconcileResult, type PurgeExpiredResult, type PurgeExpiredResponse, } from "./client.js";
+export { buildCliProvenance } from "./provenance.js";
 export { ATTACHMENTS_MARKER, attachmentsCommentBody, ghAttachmentKey, ghKeyPrefix, isValidRepo, parseRepoFromRemoteUrl, type AttachmentItem, type GhTarget, type GhTargetKind, } from "./github.js";
 export { DEFAULT_OPTIMIZE_MAX_EDGE, DEFAULT_OPTIMIZE_QUALITY, optimizeImageForUpload, rewriteKeyExtension, withImageExtension, type OptimizeImageOptions, type OptimizeImageResult, type OptimizeOutputFormat, } from "./optimize.js";
 export { FRAME_PRESETS, applyFrame, listFramePresets, resolveFrameId, type FrameFit, type FrameOptions, type FrameResult, } from "./frame.js";

package/dist/index.js

@@ -4,6 +4,7 @@ export { BUILTIN_DESTINATIONS, isBuiltinDestination, keyMatchesDestination, reso
 export { DEFAULT_API_URL, DEFAULT_WORKSPACE, UPLOADS_CONFIG_KEYS, defaultConfigPath, resolveConfigPath, loadConfigFile, loadEnvFile, resolveApiUrl, resolveConfig, describeConfigSources, redactToken, writeConfigKeys, configValuesFromClient, putDefaultsToConfigValues, resolvePutDefaults, mergePutDefaults, workspaceFromToken, workspaceMismatch, } from "./config.js";
 export { UploadsError } from "./errors.js";
 export { createUploadsClient, } from "./client.js";
+export { buildCliProvenance } from "./provenance.js";
 export { ATTACHMENTS_MARKER, attachmentsCommentBody, ghAttachmentKey, ghKeyPrefix, isValidRepo, parseRepoFromRemoteUrl, } from "./github.js";
 export { DEFAULT_OPTIMIZE_MAX_EDGE, DEFAULT_OPTIMIZE_QUALITY, optimizeImageForUpload, rewriteKeyExtension, withImageExtension, } from "./optimize.js";
 export { FRAME_PRESETS, applyFrame, listFramePresets, resolveFrameId, } from "./frame.js";

package/dist/mcp/tools.js

@@ -15,6 +15,7 @@ import { buildMarkdown } from "../embed.js";
 import { resolvePutPrefix } from "../destinations.js";
 import { ghAttachmentKey, ghKeyPrefix } from "../github.js";
 import { rewriteKeyExtension } from "../optimize.js";
+import { buildCliProvenance } from "../provenance.js";
 import { execRunner, resolveCurrentPullRequest, resolveRepo, } from "../github-gh.js";
 import { optPosInt, optString, usage } from "./args.js";
 function optBool(args, name) {
@@ -254,9 +255,11 @@ export function createUploadsMcpTools(opts) {
                     : new Uint8Array(Buffer.from(contentBase64, "base64"));
                 const sourceName = file !== undefined ? (filenameArg ?? basename(file)) : filenameArg;
                 const defaults = resolvePutDefaults({ envFile: globals.envFile });
+                const frameOpts = mcpFrameOptions(args);
+                const optimizeOpts = mcpOptimizeOptions(args, defaults);
                 const prepared = await prepareImageForUpload(bytes, sourceName, {
-                    ...mcpFrameOptions(args),
-                    optimize: mcpOptimizeOptions(args, defaults),
+                    ...frameOpts,
+                    optimize: optimizeOpts,
                 });
                 const filename = prepared.filename;
                 let key = target ? ghAttachmentKey(target, filename) : keyArg;
@@ -271,6 +274,13 @@ export function createUploadsMcpTools(opts) {
                     ref: refArg ?? defaults.ref,
                     contentType: prepared.optimized ? prepared.contentType : optString(args, "contentType"),
                     deriveRepoFromGit: !noGit,
+                    provenance: buildCliProvenance({
+                        sourceName,
+                        client: "uploads-mcp",
+                        optimized: prepared.optimized,
+                        frameId: prepared.frame?.framed ? prepared.frame.frameId : undefined,
+                        keepExif: optimizeOpts.keepExif === true,
+                    }),
                 });
                 const markdown = buildMarkdown(result.url, {
                     alt: optString(args, "alt") ?? sourceName,
@@ -352,6 +362,13 @@ export function createUploadsMcpTools(opts) {
                         filename: prepared.filename,
                         key: ghAttachmentKey(target, prepared.filename),
                         contentType: prepared.optimized ? prepared.contentType : contentType,
+                        provenance: buildCliProvenance({
+                            sourceName,
+                            client: "uploads-mcp",
+                            optimized: prepared.optimized,
+                            frameId: prepared.frame?.framed ? prepared.frame.frameId : undefined,
+                            keepExif: optimizeOpts.keepExif === true,
+                        }),
                     });
                     uploads.push({
                         ...result,

package/dist/provenance.d.ts

@@ -0,0 +1,12 @@
+/**
+ * Client-side provenance headers for put (X-Uploads-Meta-*).
+ * API allowlists keys; secrets never go here.
+ */
+import type { ProvenanceInput } from "./client.js";
+export declare function buildCliProvenance(opts: {
+    sourceName: string;
+    optimized?: boolean;
+    frameId?: string;
+    keepExif?: boolean;
+    client?: string;
+}): ProvenanceInput;

package/dist/provenance.js

@@ -0,0 +1,29 @@
+import { createRequire } from "node:module";
+let cachedVersion;
+function packageVersion() {
+    if (cachedVersion)
+        return cachedVersion;
+    try {
+        const require = createRequire(import.meta.url);
+        const pkg = require("../package.json");
+        cachedVersion = pkg.version ?? "0.0.0";
+    }
+    catch {
+        cachedVersion = "0.0.0";
+    }
+    return cachedVersion;
+}
+export function buildCliProvenance(opts) {
+    const provenance = {
+        client: opts.client ?? "uploads-cli",
+        "client-version": packageVersion(),
+        "source-name": opts.sourceName.slice(0, 128),
+    };
+    if (opts.optimized)
+        provenance.optimized = "1";
+    if (opts.frameId)
+        provenance.frame = opts.frameId.slice(0, 64);
+    if (opts.keepExif)
+        provenance["keep-exif"] = "1";
+    return provenance;
+}

package/package.json

@@ -1,8 +1,9 @@
 {
   "name": "@buildinternet/uploads",
-  "version": "0.3.0",
+  "version": "0.4.0",
   "description": "CLI and client for uploads.sh — workspace-scoped image hosting for GitHub embeds",
   "type": "module",
+  "sideEffects": false,
   "license": "MIT",
   "repository": {
     "type": "git",