cloudflare-r2-uploader 1.0.0

package/README.md

@@ -0,0 +1,214 @@
+# Cloudflare R2 Uploader
+
+A lightweight and simple uploader for **Cloudflare R2** that works with **Next.js**, **Node.js**, and any environment that supports the Web `File` API.
+
+Upload a `File` object to your Cloudflare R2 bucket and instantly get its public URL.
+
+---
+
+## Features
+
+- 🚀 Simple API
+- 📁 Upload to custom folders
+- 🖼️ File type validation
+- 📏 File size validation
+- 🔑 Automatic UUID file names
+- 🌐 Returns the public file URL
+- ⚡ Built on the official AWS S3 SDK
+
+---
+
+## Installation
+
+```bash
+npm install cloudflare-r2-uploader
+```
+
+---
+
+## Environment Variables
+
+Create a `.env` file and add the following variables:
+
+```env
+R2_BUCKET=idhomesolutions
+R2_PUBLIC_URL=https://pub-xxxxxxxxxxxxxxxx.r2.dev
+R2_ACCOUNT_ID=xxxxxxxxxxxxxxxx
+R2_ACCESS_ID=xxxxxxxxxxxxxxxx
+R2_SECRET_KEY=xxxxxxxxxxxxxxxx
+```
+
+| Variable | Description |
+|----------|-------------|
+| `R2_BUCKET` | Your Cloudflare R2 bucket name |
+| `R2_PUBLIC_URL` | Your bucket's public URL |
+| `R2_ACCOUNT_ID` | Cloudflare Account ID |
+| `R2_ACCESS_ID` | R2 Access Key ID |
+| `R2_SECRET_KEY` | R2 Secret Access Key |
+
+---
+
+## Basic Usage
+
+```js
+import upload from "cloudflare-r2-uploader"
+
+const url = await upload(file)
+
+console.log(url)
+```
+
+### Returns
+
+```text
+https://pub-xxxxxxxxxxxxxxxx.r2.dev/f87dbb66-4e88-4c47-8fc3-6b74dd4d2b9a.jpg
+```
+
+---
+
+## Upload to a Folder
+
+```js
+const url = await upload(file, {
+    folder: "avatars"
+})
+```
+
+### Returns
+
+```text
+https://pub-xxxxxxxxxxxxxxxx.r2.dev/avatars/f87dbb66-4e88-4c47-8fc3-6b74dd4d2b9a.jpg
+```
+
+---
+
+## Custom Validation
+
+```js
+await upload(file, {
+    folder: "products",
+    maxSize: 10 * 1024 * 1024,
+    allowedTypes: [
+        "image/",
+        "application/pdf"
+    ]
+})
+```
+
+---
+
+## API
+
+### upload(file, options)
+
+### Parameters
+
+| Name | Type | Required | Description |
+|------|------|----------|-------------|
+| `file` | `File` | ✅ | File to upload |
+| `options.folder` | `string` | No | Upload inside a folder |
+| `options.maxSize` | `number` | No | Maximum file size in bytes |
+| `options.allowedTypes` | `string[]` | No | Allowed MIME types |
+
+### Default Options
+
+```js
+{
+    folder: "",
+    maxSize: 5 * 1024 * 1024,
+    allowedTypes: [
+        "image/"
+    ]
+}
+```
+
+---
+
+## Allow Multiple File Types
+
+```js
+await upload(file, {
+    allowedTypes: [
+        "image/",
+        "application/pdf",
+        "video/",
+        "audio/"
+    ]
+})
+```
+
+---
+
+## Allow Only PDFs
+
+```js
+await upload(file, {
+    allowedTypes: [
+        "application/pdf"
+    ]
+})
+```
+
+---
+
+## Increase Maximum Upload Size
+
+```js
+await upload(file, {
+    maxSize: 20 * 1024 * 1024
+})
+```
+
+---
+
+## Error Handling
+
+```js
+try {
+    const url = await upload(file)
+} catch (error) {
+    console.error(error.message)
+}
+```
+
+Possible error messages:
+
+| Error | Reason |
+|-------|--------|
+| `File is required` | No file was provided |
+| `Invalid file` | Value is not a `File` object |
+| `File size must be under X MB` | File exceeds the maximum allowed size |
+| `Only image files are allowed` | Uploaded file type is not allowed |
+
+---
+
+## Example
+
+```js
+import upload from "cloudflare-r2-uploader"
+
+const imageUrl = await upload(file, {
+    folder: "users",
+    maxSize: 8 * 1024 * 1024,
+    allowedTypes: [
+        "image/"
+    ]
+})
+
+console.log(imageUrl)
+```
+
+---
+
+## Requirements
+
+- Node.js 18+
+- Cloudflare R2 Bucket
+- Public Bucket URL
+- Valid R2 API Keys
+
+---
+
+## License
+
+MIT

package/package.json

@@ -0,0 +1,25 @@
+{
+  "name": "cloudflare-r2-uploader",
+  "version": "1.0.0",
+  "description": "Simple Cloudflare R2 uploader",
+  "type": "module",
+  "main": "./src/index.js",
+  "exports": {
+    ".": "./src/index.js"
+  },
+  "files": [
+    "src"
+  ],
+  "keywords": [
+    "cloudflare",
+    "r2",
+    "upload",
+    "storage",
+    "nextjs"
+  ],
+  "author": "Muhammad Jazib",
+  "license": "MIT",
+  "dependencies": {
+    "@aws-sdk/client-s3": "^3.1090.0"
+  }
+}

package/src/index.js

@@ -0,0 +1,74 @@
+import { S3Client, PutObjectCommand } from "@aws-sdk/client-s3"
+import crypto from "crypto"
+
+const required = [
+    "R2_BUCKET",
+    "R2_PUBLIC_URL",
+    "R2_ACCOUNT_ID",
+    "R2_ACCESS_ID",
+    "R2_SECRET_KEY"
+]
+
+for (const key of required) {
+    if (!process.env[key])
+        throw new Error(`Missing environment variable: ${key}`)
+}
+
+const client = new S3Client({
+    region: "auto",
+    endpoint: `https://${process.env.R2_ACCOUNT_ID}.r2.cloudflarestorage.com`,
+    credentials: {
+        accessKeyId: process.env.R2_ACCESS_ID,
+        secretAccessKey: process.env.R2_SECRET_KEY
+    }
+})
+
+export default async function upload(
+    file,
+    {
+        folder = "",
+        maxSize = 5 * 1024 * 1024,
+        allowedTypes = ["image/"]
+    } = {}
+) {
+    if (!file)
+        throw new Error("File is required")
+
+    if (!(file instanceof File))
+        throw new Error("Invalid file. Expected a File object.")
+
+    if (file.size > maxSize)
+        throw new Error(`File size must be under ${maxSize / 1024 / 1024} MB`)
+
+    const isAllowed = allowedTypes.some(type => file.type.startsWith(type))
+
+    if (!isAllowed)
+        throw new Error(
+            `File type "${file.type}" is not allowed.`
+        )
+
+    const extension = file.name.includes(".")
+        ? file.name.split(".").pop()
+        : ""
+
+    const fileName = extension
+        ? `${crypto.randomUUID()}.${extension}`
+        : crypto.randomUUID()
+
+    const key = folder
+        ? `${folder.replace(/^\/|\/$/g, "")}/${fileName}`
+        : fileName
+
+    const buffer = Buffer.from(await file.arrayBuffer())
+
+    await client.send(
+        new PutObjectCommand({
+            Bucket: process.env.R2_BUCKET,
+            Key: key,
+            Body: buffer,
+            ContentType: file.type
+        })
+    )
+
+    return `${process.env.R2_PUBLIC_URL.replace(/\/$/, "")}/${key}`
+}