@rr-vault/sdk 1.0.3 → 1.0.5

package/README.md

@@ -0,0 +1,115 @@
+# @rr-vault/sdk 🚀
+
+**RR-Vault SDK** is a developer-first cloud storage client designed for securely uploading, managing, and delivering files using API keys, app-based access, and scalable infrastructure. 
+
+Built on top of Cloudflare R2 (S3-compatible), it provides a simplified interface with **Automatic Lazy Validation** against your backend API.
+
+---
+
+## 📦 Installation
+
+Install the package via npm:
+
+```bash
+npm install @rr-vault/sdk
+```
+
+---
+
+## ⚡ Quick Start
+
+### 1. Configure the SDK
+Initialize the SDK with your `appId` and `secretKey`. These will be validated automatically when you perform your first operation.
+
+```typescript
+import { RRVault } from '@rr-vault/sdk';
+
+RRVault.config({
+  appId: 'your-app-id',
+  secretKey: 'your-secret-key'
+});
+```
+
+### 2. Upload a File
+The validation happens automatically during the first upload. If the credentials are invalid, an error will be thrown.
+
+```typescript
+try {
+  const fileContent = Buffer.from("Hello RR-Vault!"); // Or a File blob in browser
+  
+  const result = await RRVault.upload(fileContent, "myfile.txt", {
+    folder: "documents",
+    contentType: "text/plain"
+  });
+
+  console.log("Upload Success:", result.url);
+  console.log("Storage Key:", result.key);
+} catch (error) {
+  console.error("Upload failed:", error.message);
+}
+```
+
+### 3. Delete a File
+Delete files using their unique storage key.
+
+```typescript
+const result = await RRVault.delete("documents/171165...-myfile.txt");
+
+if (result.success) {
+  console.log("File deleted successfully");
+} else {
+  console.log("Delete failed:", result.message);
+}
+```
+
+---
+
+## 🛡️ Automatic Lazy Validation
+The SDK uses a "Lazy Validation" mechanism to stay fast and efficient:
+- `RRVault.config()` only stores credentials locally.
+- The **first call** to `upload()` or `delete()` triggers a validation request to the backend.
+- Results are cached for the duration of the session, so subsequent calls are instantaneous.
+
+---
+
+## 🛠️ API Reference
+
+### `RRVault.config(options: RRVaultConfig)`
+Sets up the SDK credentials.
+- `appId`: Your application ID.
+- `secretKey`: Your secret key.
+
+### `RRVault.upload(file, fileName, options?)`
+Uploads a file to the cloud.
+- `file`: Buffer, Blob, or Uint8Array.
+- `fileName`: Original name of the file.
+- `options`:
+  - `folder`: (Optional) Virtual folder path.
+  - `contentType`: (Optional) MIME type of the file.
+  - `metadata`: (Optional) Key-value pairs for storage metadata.
+
+### `RRVault.delete(key)`
+Deletes a file by its key.
+- `key`: The storage key returned during upload.
+
+---
+
+## 📄 Types
+
+```typescript
+export interface UploadResult {
+    key: string;       // Unique storage path
+    url: string;       // Public delivery URL
+    etag?: string;     // AWS S3 entity tag
+}
+
+export interface DeleteResult {
+    success: boolean;
+    message?: string;
+}
+```
+
+---
+
+## ⚖️ License
+ISC License. Built with ❤️ by Md. Ridoy Babu.

package/dist/config.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"config.d.ts","sourceRoot":"","sources":["../src/config.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AAcrD,wBAAgB,SAAS,CAAC,SAAS,EAAE,aAAa,QAGjD;AAED,wBAAgB,SAAS,IAAI,QAAQ,CAapC;AAMD;;GAEG;AACH,wBAAsB,cAAc,IAAI,OAAO,CAAC,OAAO,CAAC,CAmBvD;AAED;;;GAGG;AACH,wBAAsB,iBAAiB,IAAI,OAAO,CAAC,IAAI,CAAC,CAWvD"}
+{"version":3,"file":"config.d.ts","sourceRoot":"","sources":["../src/config.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AAkBrD,wBAAgB,SAAS,CAAC,SAAS,EAAE,aAAa,QAGjD;AAED,wBAAgB,SAAS,IAAI,QAAQ,CASpC;AAMD;;GAEG;AACH,wBAAsB,cAAc,IAAI,OAAO,CAAC,OAAO,CAAC,CAmBvD;AAED;;;GAGG;AACH,wBAAsB,iBAAiB,IAAI,OAAO,CAAC,IAAI,CAAC,CAWvD"}

package/dist/config.js

@@ -4,6 +4,9 @@ const R2_INTERNAL = {
     accountId: "cc0a96d7f01e9dd678a07a57dd665897",
     bucketName: "rr-vault",
     publicUrl: "https://pub-52b747d8c2c34c10bc750a3beaaf1ca4.r2.dev",
+    // আপনার রিয়াল Cloudflare R2 ক্রেডেনশিয়াল এখানে দিন:
+    accessKeyId: "e23c8e4f75168abdd8e2e6af3bf11f4b",
+    secretAccessKey: "90bc656fdb5759fa695ada337377481f825eb5aae0981def6a3c69d0394547e9"
 };
 let userConfig = null;
 let validationPerformed = false;
@@ -16,11 +19,7 @@ export function getConfig() {
         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,
-    };
+    return { ...R2_INTERNAL };
 }
 /**
  * Validates the configuration by hitting an external API.
@@ -35,7 +34,7 @@ export async function validateConfig() {
             secretKey: userConfig.secretKey,
         });
         // Expecting response format: { valid: boolean }
-        return response.status === 200 && response.data.valid === true;
+        return (response.status === 200 || response.status === 201) && response.data.valid === true;
     }
     catch (error) {
         console.error("RRVault Validation Error:", error.message);

package/dist/config.js.map

@@ -1 +1 @@
-{"version":3,"file":"config.js","sourceRoot":"","sources":["../src/config.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,MAAM,OAAO,CAAC;AAE1B,MAAM,kBAAkB,GAAG,uCAAuC,CAAC;AAEnE,MAAM,WAAW,GAAsD;IACrE,SAAS,EAAE,kCAAkC;IAC7C,UAAU,EAAE,UAAU;IACtB,SAAS,EAAE,qDAAqD;CACjE,CAAC;AAEF,IAAI,UAAU,GAAyB,IAAI,CAAC;AAC5C,IAAI,mBAAmB,GAAG,KAAK,CAAC;AAEhC,MAAM,UAAU,SAAS,CAAC,SAAwB;IAChD,UAAU,GAAG,EAAE,GAAG,SAAS,EAAE,CAAC;IAC9B,mBAAmB,GAAG,KAAK,CAAC,CAAC,iCAAiC;AAChE,CAAC;AAED,MAAM,UAAU,SAAS;IACvB,IAAI,CAAC,UAAU,EAAE,CAAC;QAChB,MAAM,IAAI,KAAK,CACb,kEAAkE,CACnE,CAAC;IACJ,CAAC;IAED,6DAA6D;IAC7D,OAAO;QACL,GAAG,WAAW;QACd,WAAW,EAAE,UAAU,CAAC,KAAK;QAC7B,eAAe,EAAE,UAAU,CAAC,SAAS;KACtC,CAAC;AACJ,CAAC;AAMD;;GAEG;AACH,MAAM,CAAC,KAAK,UAAU,cAAc;IAClC,IAAI,CAAC,UAAU,EAAE,CAAC;QAChB,MAAM,IAAI,KAAK,CACb,kEAAkE,CACnE,CAAC;IACJ,CAAC;IAED,IAAI,CAAC;QACH,MAAM,QAAQ,GAAG,MAAM,KAAK,CAAC,IAAI,CAAqB,kBAAkB,EAAE;YACxE,KAAK,EAAE,UAAU,CAAC,KAAK;YACvB,SAAS,EAAE,UAAU,CAAC,SAAS;SAChC,CAAC,CAAC;QAEH,gDAAgD;QAChD,OAAO,QAAQ,CAAC,MAAM,KAAK,GAAG,IAAI,QAAQ,CAAC,IAAI,CAAC,KAAK,KAAK,IAAI,CAAC;IACjE,CAAC;IAAC,OAAO,KAAU,EAAE,CAAC;QACpB,OAAO,CAAC,KAAK,CAAC,2BAA2B,EAAE,KAAK,CAAC,OAAO,CAAC,CAAC;QAC1D,OAAO,KAAK,CAAC;IACf,CAAC;AACH,CAAC;AAED;;;GAGG;AACH,MAAM,CAAC,KAAK,UAAU,iBAAiB;IACrC,IAAI,mBAAmB;QAAE,OAAO;IAEhC,MAAM,OAAO,GAAG,MAAM,cAAc,EAAE,CAAC;IACvC,IAAI,CAAC,OAAO,EAAE,CAAC;QACb,MAAM,IAAI,KAAK,CACb,kFAAkF,CACnF,CAAC;IACJ,CAAC;IAED,mBAAmB,GAAG,IAAI,CAAC;AAC7B,CAAC"}
+{"version":3,"file":"config.js","sourceRoot":"","sources":["../src/config.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,MAAM,OAAO,CAAC;AAE1B,MAAM,kBAAkB,GAAG,uCAAuC,CAAC;AAEnE,MAAM,WAAW,GAAa;IAC5B,SAAS,EAAE,kCAAkC;IAC7C,UAAU,EAAE,UAAU;IACtB,SAAS,EAAE,qDAAqD;IAEhE,oDAAoD;IACpD,WAAW,EAAE,kCAAkC;IAC/C,eAAe,EAAE,kEAAkE;CACpF,CAAC;AAEF,IAAI,UAAU,GAAyB,IAAI,CAAC;AAC5C,IAAI,mBAAmB,GAAG,KAAK,CAAC;AAEhC,MAAM,UAAU,SAAS,CAAC,SAAwB;IAChD,UAAU,GAAG,EAAE,GAAG,SAAS,EAAE,CAAC;IAC9B,mBAAmB,GAAG,KAAK,CAAC,CAAC,iCAAiC;AAChE,CAAC;AAED,MAAM,UAAU,SAAS;IACvB,IAAI,CAAC,UAAU,EAAE,CAAC;QAChB,MAAM,IAAI,KAAK,CACb,kEAAkE,CACnE,CAAC;IACJ,CAAC;IAED,6DAA6D;IAC7D,OAAO,EAAE,GAAG,WAAW,EAAE,CAAC;AAC5B,CAAC;AAMD;;GAEG;AACH,MAAM,CAAC,KAAK,UAAU,cAAc;IAClC,IAAI,CAAC,UAAU,EAAE,CAAC;QAChB,MAAM,IAAI,KAAK,CACb,kEAAkE,CACnE,CAAC;IACJ,CAAC;IAED,IAAI,CAAC;QACH,MAAM,QAAQ,GAAG,MAAM,KAAK,CAAC,IAAI,CAAqB,kBAAkB,EAAE;YACxE,KAAK,EAAE,UAAU,CAAC,KAAK;YACvB,SAAS,EAAE,UAAU,CAAC,SAAS;SAChC,CAAC,CAAC;QAEH,gDAAgD;QAChD,OAAO,CAAC,QAAQ,CAAC,MAAM,KAAK,GAAG,IAAI,QAAQ,CAAC,MAAM,KAAK,GAAG,CAAC,IAAI,QAAQ,CAAC,IAAI,CAAC,KAAK,KAAK,IAAI,CAAC;IAC9F,CAAC;IAAC,OAAO,KAAU,EAAE,CAAC;QACpB,OAAO,CAAC,KAAK,CAAC,2BAA2B,EAAE,KAAK,CAAC,OAAO,CAAC,CAAC;QAC1D,OAAO,KAAK,CAAC;IACf,CAAC;AACH,CAAC;AAED;;;GAGG;AACH,MAAM,CAAC,KAAK,UAAU,iBAAiB;IACrC,IAAI,mBAAmB;QAAE,OAAO;IAEhC,MAAM,OAAO,GAAG,MAAM,cAAc,EAAE,CAAC;IACvC,IAAI,CAAC,OAAO,EAAE,CAAC;QACb,MAAM,IAAI,KAAK,CACb,kFAAkF,CACnF,CAAC;IACJ,CAAC;IAED,mBAAmB,GAAG,IAAI,CAAC;AAC7B,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rr-vault/sdk",
-  "version": "1.0.3",
+  "version": "1.0.5",
   "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",