@rr-vault/sdk 1.0.0 → 1.0.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rr-vault/sdk",
-  "version": "1.0.0",
+  "version": "1.0.1",
   "description": "\"RR-Vault SDK is a developer-first cloud storage client for securely uploading, managing, and delivering files using API keys, app-based access, and scalable infrastructure.\"",
   "keywords": [],
   "homepage": "https://github.com/mdrezuanislamridoy/rr-vault-sdk#readme",
@@ -14,8 +14,17 @@
   "license": "ISC",
   "author": "Ridoy781 <ridoy.babu.781@gmail.com>",
   "type": "module",
-  "main": "index.js",
+  "main": "src/index.js",
   "scripts": {
     "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  "devDependencies": {
+    "@types/node": "^25.5.0"
+  },
+  "dependencies": {
+    "@aws-sdk/client-s3": "^3.1019.0",
+    "@aws-sdk/lib-storage": "^3.1019.0",
+    "@types/axios": "^0.9.36",
+    "axios": "^1.14.0"
   }
 }

package/src/config.ts

@@ -0,0 +1,33 @@
+import { RRVaultConfig, R2Config } from "./types";
+
+/**
+ * Internal R2 settings. 
+ * Ridoy: Replace these placeholders with your actual Cloudflare R2 values.
+ */
+const R2_INTERNAL: Omit<R2Config, "accessKeyId" | "secretAccessKey"> = {
+  accountId: "YOUR_ACCOUNT_ID",
+  bucketName: "YOUR_BUCKET_NAME",
+  publicUrl: "https://pub-your-id.r2.dev",
+};
+
+let userConfig: RRVaultConfig | null = null;
+
+export function setConfig(newConfig: RRVaultConfig) {
+  userConfig = { ...newConfig };
+}
+
+export function getConfig(): R2Config {
+  if (!userConfig) {
+    throw new Error(
+      "RRVault: SDK not configured. Please call RRVault.config() first."
+    );
+  }
+
+  // Map user-facing appId/secretKey to internal R2 credentials
+  return {
+    ...R2_INTERNAL,
+    accessKeyId: userConfig.appId,
+    secretAccessKey: userConfig.secretKey,
+  };
+}
+

package/src/index.ts

@@ -0,0 +1,39 @@
+import { setConfig } from "./config";
+import { upload as s3Upload, deleteFile as s3Delete } from "./s3";
+import { RRVaultConfig, R2Config, UploadOptions, UploadResult, DeleteResult } from "./types";
+
+export class RRVault {
+
+  static config(config: RRVaultConfig) {
+    setConfig(config);
+  }
+
+
+  static async upload(
+    file: any,
+    fileName: string,
+    options: UploadOptions = {}
+  ): Promise<UploadResult> {
+    return await s3Upload(file, fileName, options);
+  }
+
+  static async delete(key: string): Promise<DeleteResult> {
+    return await s3Delete(key);
+  }
+}
+
+// Functional approach exports
+export { 
+  setConfig as config, 
+  s3Upload as upload, 
+  s3Delete as deleteFile 
+};
+
+// Type exports
+export type { 
+  RRVaultConfig,
+  R2Config, 
+  UploadOptions, 
+  UploadResult, 
+  DeleteResult 
+};

package/src/s3.ts

@@ -0,0 +1,88 @@
+import { S3Client, PutObjectCommand, DeleteObjectCommand } from "@aws-sdk/client-s3";
+import { getConfig } from "./config";
+import { UploadOptions, UploadResult, DeleteResult } from "./types";
+
+let s3Client: S3Client | null = null;
+
+function getS3Client() {
+  if (s3Client) return s3Client;
+  const config = getConfig();
+  
+  s3Client = new S3Client({
+    region: "auto",
+    endpoint: `https://${config.accountId}.r2.cloudflarestorage.com`,
+    credentials: {
+      accessKeyId: config.accessKeyId,
+      secretAccessKey: config.secretAccessKey,
+    },
+  });
+  
+  return s3Client;
+}
+
+/**
+ * Upload a file to Cloudflare R2
+ * @param file - File content (Buffer, Blob, Uint8Array)
+ * @param fileName - Original name of the file
+ * @param options - Additional upload options
+ */
+export async function upload(
+  file: any,
+  fileName: string,
+  options: UploadOptions = {}
+): Promise<UploadResult> {
+  const config = getConfig();
+  const client = getS3Client();
+  
+  // Clean folder path and construct key
+  const folder = options.folder ? `${options.folder.replace(/\/$/, "")}/` : "";
+  const key = `${folder}${Date.now()}-${fileName.replace(/\s+/g, "-")}`;
+
+  const command = new PutObjectCommand({
+    Bucket: config.bucketName,
+    Key: key,
+    Body: file,
+    ContentType: options.contentType || "application/octet-stream",
+    Metadata: options.metadata,
+    CacheControl: options.cacheControl,
+  });
+
+  const response = await client.send(command);
+
+  // Construct public URL
+  const baseUrl = config.publicUrl 
+    ? config.publicUrl.replace(/\/$/, "") 
+    : `https://${config.bucketName}.${config.accountId}.r2.dev`;
+    
+  const url = `${baseUrl}/${key}`;
+
+  return {
+    key,
+    url,
+    etag: response.ETag,
+  };
+}
+
+/**
+ * Delete a file from Cloudflare R2
+ * @param key - The storage key (path) of the file
+ */
+export async function deleteFile(key: string): Promise<DeleteResult> {
+  const config = getConfig();
+  const client = getS3Client();
+
+  const command = new DeleteObjectCommand({
+    Bucket: config.bucketName,
+    Key: key,
+  });
+
+  try {
+    await client.send(command);
+    return { success: true };
+  } catch (error: any) {
+    return { 
+      success: false, 
+      message: error.message || "Failed to delete file from R2" 
+    };
+  }
+}

package/src/types.ts

@@ -0,0 +1,30 @@
+export interface RRVaultConfig {
+    appId: string;
+    secretKey: string;
+}
+
+export interface R2Config {
+    accountId: string;
+    accessKeyId: string;
+    secretAccessKey: string;
+    bucketName: string;
+    publicUrl?: string;
+}
+
+export interface UploadOptions {
+    folder?: string;
+    contentType?: string;
+    metadata?: Record<string, string>;
+    cacheControl?: string;
+}
+
+export interface UploadResult {
+    key: string;
+    url: string;
+    etag?: string;
+}
+
+export interface DeleteResult {
+    success: boolean;
+    message?: string;
+}

package/verify_r2.ts

@@ -0,0 +1,39 @@
+import { RRVault } from "./src/index";
+
+
+const testConfig = {
+  appId: "YOUR_APP_ID",
+  secretKey: "YOUR_SECRET_KEY",
+};
+
+
+async function runTest() {
+  console.log("🚀 Starting RRVault R2 Test...");
+
+  try {
+    // 1. Configure
+    RRVault.config(testConfig);
+    console.log("✅ Configured successfully.");
+
+    // 2. Upload
+    const fileContent = Buffer.from("Hello RRVault R2!");
+    const uploadResult = await RRVault.upload(fileContent, "test.txt", {
+      folder: "tests",
+      contentType: "text/plain",
+    });
+    console.log("✅ Upload successful:", uploadResult);
+
+    // 3. Delete
+    console.log("🕒 Waiting 2 seconds before delete...");
+    await new Promise((resolve) => setTimeout(resolve, 2000));
+
+    const deleteResult = await RRVault.delete(uploadResult.key);
+    console.log("✅ Delete result:", deleteResult);
+
+  } catch (error) {
+    console.error("❌ Test failed:", error);
+  }
+}
+
+// runTest();
+console.log("Verification script ready. Update credentials and uncomment runTest() to execute.");

package/index.js

@@ -1,3 +0,0 @@
-export default function RRVault() {
-  console.log("My First NPM Package");
-}