kap-r2 1.0.7 → 1.1.0

package/dist/index.js

@@ -7,13 +7,7 @@ exports.shareServices = void 0;
 const promises_1 = require("fs/promises");
 const path_1 = __importDefault(require("path"));
 const https_1 = __importDefault(require("https"));
-const os_1 = __importDefault(require("os"));
 const aws4_1 = __importDefault(require("aws4"));
-const logFile = path_1.default.join(os_1.default.homedir(), "kap-r2-debug.log");
-const log = async (msg) => {
-    const line = `[${new Date().toISOString()}] ${msg}\n`;
-    await (0, promises_1.appendFile)(logFile, line).catch(() => { });
-};
 const contentTypes = new Map([
     [".gif", "image/gif"],
     [".mp4", "video/mp4"],
@@ -51,9 +45,6 @@ const action = async (context) => {
     const filePath = await context.filePath();
     const fileStats = await (0, promises_1.stat)(filePath);
     const fileBuffer = await (0, promises_1.readFile)(filePath);
-    await log(`--- New upload ---`);
-    await log(`File: ${filePath}, Size: ${fileStats.size}`);
-    await log(`Account: ${accountId}, Bucket: ${bucket}`);
     context.setProgress("Uploading to R2…", 0);
     const filename = path_1.default.basename(filePath);
     const key = directory ? path_1.default.posix.join(directory, filename) : filename;
@@ -62,9 +53,6 @@ const action = async (context) => {
     const host = `${accountId}.r2.cloudflarestorage.com`;
     const encodedKey = key.split("/").map(encodeURIComponent).join("/");
     const fullPath = `/${bucket}/${encodedKey}`;
-    await log(`Host: ${host}`);
-    await log(`Path: ${fullPath}`);
-    await log(`Content-Type: ${contentType}`);
     const request = aws4_1.default.sign({
         host,
         path: fullPath,
@@ -80,10 +68,8 @@ const action = async (context) => {
         accessKeyId,
         secretAccessKey,
     });
-    await log(`Signed headers: ${JSON.stringify(request.headers)}`);
     try {
         await new Promise((resolve, reject) => {
-            log(`Making HTTPS request...`);
             const req = https_1.default.request({
                 hostname: host,
                 path: fullPath,
@@ -92,10 +78,8 @@ const action = async (context) => {
             }, (res) => {
                 const chunks = [];
                 res.on("data", (chunk) => chunks.push(chunk));
-                res.on("end", async () => {
+                res.on("end", () => {
                     const body = Buffer.concat(chunks).toString();
-                    await log(`Response status: ${res.statusCode}`);
-                    await log(`Response body: ${body}`);
                     if (res.statusCode && res.statusCode >= 200 && res.statusCode < 300) {
                         resolve();
                     }
@@ -104,10 +88,7 @@ const action = async (context) => {
                     }
                 });
             });
-            req.on("error", (err) => {
-                log(`Request error: ${err.message}`);
-                reject(err);
-            });
+            req.on("error", reject);
             context.setProgress("Uploading to R2…", 0.5);
             req.end(fileBuffer);
         });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "kap-r2",
-  "version": "1.0.7",
+  "version": "1.1.0",
   "description": "Share on Cloudflare R2",
   "license": "MIT",
   "repository": "tristanremy/kap-r2",

package/readme.md

@@ -1,37 +1,110 @@
 # kap-r2
 
-> [Kap](https://github.com/wulkano/Kap) plugin - Share on Cloudflare R2
+> [Kap](https://github.com/wulkano/Kap) plugin - Upload recordings to Cloudflare R2
+
+Instantly share your Kap screen recordings via Cloudflare R2 storage. After recording, your file is uploaded and the public URL is automatically copied to your clipboard.
 
 ## Install
 
-In the `Kap` menu, go to `Preferences…`, select the `Plugins` pane, find this plugin, and click `Install`.
+In the `Kap` menu, go to `Preferences…`, select the `Plugins` pane, search for `kap-r2`, and click `Install`.
 
 ## Configuration
 
+After installing, click the gear icon next to the plugin to configure it.
+
 | Setting | Description |
 |---------|-------------|
-| **Account ID** | Your Cloudflare account ID |
+| **Account ID** | Your Cloudflare account ID (32-character hex string) |
 | **Access Key ID** | R2 API token access key |
 | **Secret Access Key** | R2 API token secret |
 | **Bucket Name** | Name of your R2 bucket |
 | **Directory** | Optional subfolder path (e.g., `recordings/`) |
-| **Public URL** | Your bucket's public URL (R2.dev or custom domain) |
+| **Public URL** | Your bucket's public URL (must start with `https://`) |
+
+## Setup Guide
+
+### Step 1: Find Your Account ID
+
+1. Log in to the [Cloudflare Dashboard](https://dash.cloudflare.com)
+2. Select your account
+3. Go to **R2** in the left sidebar
+4. Your **Account ID** is displayed in the right sidebar under "Account details"
+
+### Step 2: Create an R2 Bucket
+
+1. In the R2 section, click **Create bucket**
+2. Enter a bucket name (lowercase letters, numbers, and hyphens only)
+3. Click **Create bucket**
+
+### Step 3: Enable Public Access
+
+You need to make your bucket publicly accessible. Choose one option:
 
-### Getting R2 API Credentials
+#### Option A: R2.dev Subdomain (Easiest)
 
-1. Go to [Cloudflare Dashboard](https://dash.cloudflare.com)
-2. Navigate to **R2** > **Manage R2 API Tokens**
-3. Click **Create API Token**
-4. Grant **Object Read & Write** permissions
-5. Save the **Access Key ID** and **Secret Access Key**
+1. Click on your bucket
+2. Go to **Settings** tab
+3. Under "Public access", find **R2.dev subdomain**
+4. Click **Allow Access**
+5. Copy the provided URL (e.g., `https://pub-abc123.r2.dev`)
 
-### Setting Up Public Access
+#### Option B: Custom Domain
 
-Enable the R2.dev subdomain in bucket settings or connect a custom domain.
+1. Click on your bucket
+2. Go to **Settings** tab
+3. Under "Public access", click **Connect Domain**
+4. Follow the instructions to add your custom domain
+5. Use your domain as the Public URL (e.g., `https://cdn.yourdomain.com`)
+
+### Step 4: Create API Credentials
+
+1. In the R2 section, click **Manage R2 API Tokens** (top right)
+2. Click **Create API token**
+3. Give it a name (e.g., "Kap Upload")
+4. Under "Permissions", select **Object Read & Write**
+5. Under "Specify bucket(s)", choose your bucket or select "Apply to all buckets"
+6. Click **Create API Token**
+7. **Important**: Copy both the **Access Key ID** and **Secret Access Key** immediately — the secret is only shown once!
+
+### Step 5: Configure the Plugin
+
+1. Open Kap → Preferences → Plugins
+2. Click the gear icon next to kap-r2
+3. Fill in all the fields:
+   - **Account ID**: The 32-character ID from Step 1
+   - **Access Key ID**: From Step 4
+   - **Secret Access Key**: From Step 4
+   - **Bucket Name**: The name you chose in Step 2
+   - **Directory**: Leave empty or enter a folder name (optional)
+   - **Public URL**: The URL from Step 3 (must start with `https://`)
 
 ## Usage
 
-After recording in Kap, select an export format, then click **Share to R2**.
+1. Record your screen with Kap
+2. Choose an export format (GIF, MP4, WebM, or APNG)
+3. Click **Share to R2**
+4. Wait for the upload to complete
+5. The public URL is automatically copied to your clipboard
+
+## Troubleshooting
+
+### "Export cancelled" immediately
+- Make sure all required fields are configured in the plugin settings
+- Check that your Account ID is exactly 32 characters (lowercase hex)
+- Verify your Public URL starts with `https://`
+
+### Upload fails with authentication error
+- Double-check your Access Key ID and Secret Access Key
+- Make sure your API token has "Object Read & Write" permission
+- Verify the token has access to the specified bucket
+
+### File not appearing in bucket
+- Check the Cloudflare R2 dashboard to see if the file was uploaded
+- Verify your bucket name is correct (case-sensitive)
+
+### URL doesn't work
+- Make sure public access is enabled on your bucket
+- Verify the Public URL matches your R2.dev subdomain or custom domain exactly
 
 ## License