kap-r2 1.1.0 → 1.3.0

package/dist/index.d.ts

@@ -1,9 +1,17 @@
 interface KapConfig {
     get(key: string): string;
 }
+interface RequestOptions {
+    method?: string;
+    headers?: Record<string, string | number | undefined>;
+    body?: Buffer;
+}
 interface KapContext {
     filePath(): Promise<string>;
     config: KapConfig;
+    request(url: string, options?: RequestOptions): Promise<{
+        body: string;
+    }>;
     setProgress(text: string, percentage?: number): void;
     copyToClipboard(text: string): void;
     notify(text: string, action?: () => void): void;
@@ -51,6 +59,13 @@ export declare const shareServices: {
             default: string;
             required: boolean;
         };
+        addTimestamp: {
+            title: string;
+            description: string;
+            type: string;
+            default: boolean;
+            required: boolean;
+        };
     };
 }[];
 export {};

package/dist/index.js

@@ -6,7 +6,6 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.shareServices = void 0;
 const promises_1 = require("fs/promises");
 const path_1 = __importDefault(require("path"));
-const https_1 = __importDefault(require("https"));
 const aws4_1 = __importDefault(require("aws4"));
 const contentTypes = new Map([
     [".gif", "image/gif"],
@@ -37,29 +36,31 @@ const action = async (context) => {
         context.cancel();
         return;
     }
-    if (!publicUrl.startsWith("https://")) {
-        context.notify("Public URL must start with https://");
+    if (!/^https:\/\/.+/.test(publicUrl)) {
+        context.notify("Public URL must be a valid https:// URL");
         context.cancel();
         return;
     }
     const filePath = await context.filePath();
-    const fileStats = await (0, promises_1.stat)(filePath);
     const fileBuffer = await (0, promises_1.readFile)(filePath);
     context.setProgress("Uploading to R2…", 0);
-    const filename = path_1.default.basename(filePath);
+    const addTimestamp = context.config.get("addTimestamp") === "true";
+    const originalFilename = path_1.default.basename(filePath);
+    const filename = addTimestamp ? `${Date.now()}-${originalFilename}` : originalFilename;
     const key = directory ? path_1.default.posix.join(directory, filename) : filename;
     const extension = path_1.default.extname(filename);
     const contentType = contentTypes.get(extension) || "application/octet-stream";
     const host = `${accountId}.r2.cloudflarestorage.com`;
     const encodedKey = key.split("/").map(encodeURIComponent).join("/");
     const fullPath = `/${bucket}/${encodedKey}`;
-    const request = aws4_1.default.sign({
+    const url = `https://${host}${fullPath}`;
+    const signed = aws4_1.default.sign({
         host,
         path: fullPath,
         method: "PUT",
         headers: {
             "Content-Type": contentType,
-            "Content-Length": fileStats.size,
+            "Content-Length": fileBuffer.length,
         },
         body: fileBuffer,
         service: "s3",
@@ -69,28 +70,11 @@ const action = async (context) => {
         secretAccessKey,
     });
     try {
-        await new Promise((resolve, reject) => {
-            const req = https_1.default.request({
-                hostname: host,
-                path: fullPath,
-                method: "PUT",
-                headers: request.headers,
-            }, (res) => {
-                const chunks = [];
-                res.on("data", (chunk) => chunks.push(chunk));
-                res.on("end", () => {
-                    const body = Buffer.concat(chunks).toString();
-                    if (res.statusCode && res.statusCode >= 200 && res.statusCode < 300) {
-                        resolve();
-                    }
-                    else {
-                        reject(new Error(`HTTP ${res.statusCode}: ${body}`));
-                    }
-                });
-            });
-            req.on("error", reject);
-            context.setProgress("Uploading to R2…", 0.5);
-            req.end(fileBuffer);
+        context.setProgress("Uploading to R2…", 0.5);
+        await context.request(url, {
+            method: "PUT",
+            headers: signed.headers,
+            body: fileBuffer,
         });
         const baseUrl = publicUrl.replace(/\/$/, "");
         const uploadUrl = `${baseUrl}/${encodedKey}`;
@@ -118,7 +102,7 @@ const r2 = {
     title: "Share to R2",
     formats: ["gif", "mp4", "webm", "apng"],
     action,
-    configDescription: "Configure your Cloudflare R2 credentials. Get your API tokens from the Cloudflare dashboard under R2 > Manage R2 API Tokens.",
+    configDescription: "Configure your Cloudflare R2 credentials. Get your API tokens from https://dash.cloudflare.com/?to=/:account/r2/api-tokens",
     config: {
         accountId: {
             title: "Account ID",
@@ -156,6 +140,13 @@ const r2 = {
             default: "",
             required: true,
         },
+        addTimestamp: {
+            title: "Add Timestamp to Filename",
+            description: "Prefix filenames with timestamp to avoid overwrites",
+            type: "boolean",
+            default: false,
+            required: false,
+        },
     },
 };
 exports.shareServices = [r2];

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "kap-r2",
-  "version": "1.1.0",
+  "version": "1.3.0",
   "description": "Share on Cloudflare R2",
   "license": "MIT",
   "repository": "tristanremy/kap-r2",
@@ -29,12 +29,15 @@
   "devDependencies": {
     "@types/aws4": "^1.11.6",
     "@types/node": "^20.0.0",
+    "ava": "^5.3.1",
+    "kap-plugin-test": "^0.5.0",
     "typescript": "^5.0.0"
   },
   "engines": {
     "node": ">=14"
   },
   "scripts": {
-    "build": "tsc"
+    "build": "tsc",
+    "test": "pnpm build && ava"
   }
 }

package/readme.md

@@ -1,110 +1,30 @@
 # kap-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.
+> [Kap](https://github.com/wulkano/kap) plugin - Share on [Cloudflare R2](https://www.cloudflare.com/products/r2/)
 
 ## 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 (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 (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:
-
-#### Option A: R2.dev Subdomain (Easiest)
-
-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`)
-
-#### Option B: 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://`)
+In the `Kap` menu, go to `Preferences…`, select the `Plugins` pane, find this plugin, and click `Install`.
 
 ## Usage
 
-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
+1. Configure your R2 credentials by clicking the gear icon next to the plugin
+2. After recording, select an export format and click `Share to R2`
+3. The public URL is copied to your clipboard
 
-### 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)
+## Configuration
 
-### 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
+| Setting | Description |
+|---------|-------------|
+| Account ID | Your Cloudflare account ID (32-character hex) |
+| Access Key ID | R2 API token access key |
+| Secret Access Key | R2 API token secret |
+| Bucket Name | Your R2 bucket name |
+| Directory | Optional subfolder path |
+| Public URL | Your bucket's public URL (e.g., `https://pub-xxx.r2.dev`) |
+| Add Timestamp to Filename | Prefix filenames with timestamp to avoid overwrites |
+
+Get your API credentials from the [Cloudflare R2 API Tokens page](https://dash.cloudflare.com/?to=/:account/r2/api-tokens).
 
 ## License