dpu-cloud-sdk 1.0.0 → 1.0.1

package/README.md

@@ -0,0 +1,403 @@
+# DPU Cloud SDK
+
+A comprehensive TypeScript SDK for interacting with DPU (Data Processing Unit) storage services. This package provides upload, download, compression, and translation capabilities for file management in cloud environments.
+
+## Features
+
+- 📁 **File Upload & Download** - Support for single and multi-part uploads with progress tracking
+- 🗜️ **Compression** - Compress folders and monitor compression status
+- 🌐 **Translation** - Translate files between different formats
+- ⚙️ **Configurable Base URL** - Customize domain for different environments
+- 🔐 **Token Management** - Built-in token refresh support
+- 🚀 **Worker Threads** - Parallel file processing with automatic worker management
+- ♻️ **Retry Logic** - Automatic retry with exponential backoff
+- 📊 **Progress Tracking** - Real-time upload/download progress callbacks
+
+## Installation
+
+```bash
+npm install dpu-cloud-sdk
+```
+
+## Quick Start
+
+### Basic Setup
+
+```typescript
+import { DPUClient } from 'dpu-cloud-sdk';
+
+const client = new DPUClient(
+  accessToken,
+  refreshTokenCallback
+);
+```
+
+### With Custom Base URL
+
+```typescript
+import { DPUClient } from 'dpu-cloud-sdk';
+
+const client = new DPUClient(
+  accessToken,
+  refreshTokenCallback,
+  3, // maxRetry
+  'https://your-custom-domain.com' // Custom base URL
+);
+```
+
+## Configuration
+
+### Setting Base URL
+
+There are multiple ways to configure the base URL:
+
+#### 1. Via Constructor (Recommended)
+```typescript
+const client = new DPUClient(
+  accessToken,
+  refreshTokenCallback,
+  maxRetry,
+  'https://api.yourdomain.com'
+);
+```
+
+#### 2. Via dpuConfig (Global)
+```typescript
+import { dpuConfig, DPUClient } from 'dpu-cloud-sdk';
+
+// Set globally before creating client
+dpuConfig.setBaseURL('https://api.yourdomain.com');
+
+const client = new DPUClient(accessToken, refreshTokenCallback);
+```
+
+#### 3. Via setConfig
+```typescript
+import { dpuConfig } from 'dpu-cloud-sdk';
+
+dpuConfig.setConfig({
+  baseURL: 'https://api.yourdomain.com'
+});
+```
+
+### Environment-based Configuration
+
+```typescript
+// For development
+dpuConfig.setBaseURL(process.env.REACT_APP_API_URL || 'https://dev-api.yourdomain.com');
+
+// For production
+dpuConfig.setBaseURL('https://api.yourdomain.com');
+```
+
+## Usage Examples
+
+### File Upload
+
+#### Single File Upload with Progress
+```typescript
+import { DPUClient } from 'dpu-cloud-sdk';
+
+const client = new DPUClient(accessToken, refreshTokenCallback);
+
+const uploadedId = await client.uploadSingleFile(
+  bucketName,
+  fileKey,
+  file,
+  {
+    onProgress: (percentage) => {
+      console.log(`Upload progress: ${percentage}%`);
+    }
+  }
+);
+```
+
+#### Multiple Files Upload
+```typescript
+const fileMap = new Map([
+  [fileKey1, file1],
+  [fileKey2, file2],
+  [fileKey3, file3]
+]);
+
+const results = await client.uploadMultipleFiles(
+  bucketName,
+  fileMap,
+  {
+    onProgress: (fileKey, percentage) => {
+      console.log(`${fileKey}: ${percentage}%`);
+    }
+  }
+);
+```
+
+### File Download
+
+```typescript
+const downloadUrl = await client.getUrlToDownload(
+  bucketName,
+  fileName
+);
+
+// Download the file
+window.location.href = downloadUrl;
+```
+
+### Compression
+
+#### Compress Folder
+```typescript
+const compressResult = await client.compressFolder(
+  bucketName,
+  folderPath,
+  {
+    onProgress: (status) => {
+      console.log('Compression status:', status);
+    }
+  }
+);
+
+console.log('Compression ID:', compressResult.dataId);
+```
+
+#### Get Compression Status
+```typescript
+const status = await client.getStatusCompress(compressionId);
+console.log('Compression status:', status);
+```
+
+### Translation
+
+#### Translate File
+```typescript
+const translateRequest = {
+  bucketName: 'my-bucket',
+  fileName: 'document.pdf',
+  targetFormat: 'docx'
+};
+
+const translateResult = await client.translateFile(translateRequest);
+console.log('Translation ID:', translateResult.dataId);
+```
+
+#### Get Translation Status
+```typescript
+const status = await client.getStatusTranslate(translateId);
+console.log('Translation progress:', status.percentage);
+```
+
+#### Get Translation Status for Specific File
+```typescript
+const fileStatus = await client.getStatusTranslateFile(
+  translateId,
+  fileName
+);
+```
+
+## API Methods
+
+### DPUClient Methods
+
+#### Upload Methods
+- `uploadSingleFile(bucketName, fileKey, file, options?)` - Upload a single file
+- `uploadMultipleFiles(bucketName, fileMap, options?)` - Upload multiple files
+- `uploadSingleFileWithCustomFileName(bucketName, customName, file, options?)` - Upload with custom name
+- `uploadSingleFileWithInitUpload(bucketName, fileKey, file, options?)` - Upload with init upload
+
+#### Download Methods
+- `getUrlToDownload(bucketName, fileName)` - Get download URL
+- `downloadSingleFile(bucketName, fileName, options?)` - Download file directly
+- `downloadMultipleFiles(bucketName, fileNames, options?)` - Download multiple files
+
+#### Compression Methods
+- `compressFolder(bucketName, folderPath, options?)` - Compress a folder
+- `getStatusCompress(compressionId)` - Check compression status
+- `cancelCompressionDownload(compressionId)` - Cancel compression
+
+#### Translation Methods
+- `translateFile(request, options?)` - Start file translation
+- `getStatusTranslate(translateId)` - Get translation status
+- `getStatusTranslateFile(translateId, fileName)` - Get specific file translation status
+- `getEPSGRegionCode(region)` - Get EPSG code for region
+- `getFileTileSet(translateId)` - Get file tile set
+
+#### Object Methods
+- `getObjectDetail(bucketName, fileName)` - Get object details
+- `getObjects(bucketName)` - List objects in bucket
+- `applyPermissionToObjects(data)` - Apply permissions to objects
+
+## Configuration Options
+
+### DPUClient Constructor
+
+```typescript
+new DPUClient(
+  accessToken?: string,           // JWT access token
+  reFreshToken?: () => Promise<string>,  // Callback to refresh token
+  maxRetry?: number,              // Max retry attempts (default: 3)
+  baseURL?: string                // Custom API base URL
+)
+```
+
+### Upload Options
+
+```typescript
+interface UploadOptions {
+  onProgress?: (percentage: number) => void;
+  cancellationToken?: AbortController;
+  fileKey?: string;
+  dataUploadId?: string;
+}
+```
+
+### Download Options
+
+```typescript
+interface DownloadOptions {
+  onProgress?: (loadedBytes: number, totalBytes: number) => void;
+  cancellationToken?: AbortController;
+}
+```
+
+## Error Handling
+
+The SDK includes built-in error handling with automatic retries for transient failures:
+
+```typescript
+try {
+  const result = await client.uploadSingleFile(bucketName, fileKey, file);
+  console.log('Upload successful:', result);
+} catch (error) {
+  console.error('Upload failed:', error.message);
+  // Handle error appropriately
+}
+```
+
+### Common Error Status Codes
+
+- `200` - Success
+- `400` - Bad Request
+- `401` - Unauthorized (Token expired or invalid)
+- `403` - Forbidden (Insufficient permissions)
+- `404` - Not Found (Resource doesn't exist)
+- `500` - Internal Server Error
+
+## Token Management
+
+### Automatic Token Refresh
+
+Provide a refresh token callback to automatically refresh tokens when they expire:
+
+```typescript
+const refreshTokenCallback = async () => {
+  const response = await fetch('/api/refresh-token', {
+    method: 'POST',
+    headers: { 'Content-Type': 'application/json' }
+  });
+  const { token } = await response.json();
+  return token;
+};
+
+const client = new DPUClient(
+  initialAccessToken,
+  refreshTokenCallback
+);
+```
+
+## Advanced Usage
+
+### Cancelling Operations
+
+Use `AbortController` to cancel ongoing operations:
+
+```typescript
+const cancellationToken = new AbortController();
+
+setTimeout(() => {
+  cancellationToken.abort(); // Cancel after 5 seconds
+}, 5000);
+
+try {
+  await client.uploadSingleFile(
+    bucketName,
+    fileKey,
+    largeFile,
+    { cancellationToken }
+  );
+} catch (error) {
+  if (error.name === 'AbortError') {
+    console.log('Upload cancelled');
+  }
+}
+```
+
+### Parallel Uploads with Progress
+
+```typescript
+const files = [file1, file2, file3];
+
+const promises = files.map((file, index) =>
+  client.uploadSingleFile(
+    bucketName,
+    `file-${index}`,
+    file,
+    {
+      onProgress: (percentage) => {
+        console.log(`File ${index}: ${percentage}%`);
+      }
+    }
+  )
+);
+
+const results = await Promise.all(promises);
+```
+
+## Performance Tips
+
+1. **Use Multiple Files Upload** - More efficient for batch operations than individual uploads
+2. **Monitor Progress** - Implement progress callbacks for better UX
+3. **Optimize Chunk Size** - Default is 5MB per chunk (configurable)
+4. **Limit Concurrent Workers** - Default max 20 workers (adjust based on system resources)
+5. **Handle Token Refresh** - Implement token refresh callback to avoid interruptions
+
+## Browser Compatibility
+
+- Chrome 90+
+- Firefox 88+
+- Safari 14+
+- Edge 90+
+
+## TypeScript Support
+
+This package is fully typed with TypeScript. All models and interfaces are exported:
+
+```typescript
+import {
+  DPUClient,
+  dpuConfig,
+  InitUploadResponse,
+  PresignURLResponse,
+  TranslateInfo,
+  CompressStatus
+} from 'dpu-cloud-sdk';
+```
+
+## Support & Documentation
+
+For issues, questions, or contributions, please contact the development team or check the internal documentation.
+
+## License
+
+ISC
+
+## Changelog
+
+### v1.0.0
+- Initial release
+- File upload/download functionality
+- Compression support
+- Translation support
+- Configurable base URL
+- Token refresh support
+- Progress tracking
+- Retry logic

package/dist/DPUClient.d.ts

@@ -43,7 +43,7 @@ export declare class DPUClient {
     uploadFileRetry(bucketName: string, file: File, cancellationToken: AbortController, onProgress?: (chunkUploaded: number) => void, maxWebWorker?: number, prefix?: string, initUpload?: InitUploadResponse, customFileName?: string, worker?: Worker, dataUploadId?: string): Promise<unknown>;
     uploadFile(bucketName: string, file: File, cancellationToken: AbortController, onProgress?: (chunkUploaded: number) => void, maxWebWorker?: number, prefix?: string, initUpload?: InitUploadResponse, customFileName?: string, worker?: Worker, dataUploadId?: string): Promise<unknown>;
     private runOnWorker;
-    uploadFolderAferInit(filesInitiated: {
+    uploadFolderAfterInit(filesInitiated: {
         file: File;
         fileKey: string;
         path: string;

package/dist/DPUClient.js

@@ -185,7 +185,7 @@ export class DPUClient {
             for (let index = 0; index < maxWorker; index++) {
                 const channel = new MessageChannel();
                 const worker = new Worker(new URL("workerUploadChildFile", import.meta.url));
-                worker.postMessage({ port: channel.port2 }, [channel.port2]);
+                worker.postMessage({ port: channel.port2, baseURL: dpuConfig.getBaseURL() }, [channel.port2]);
                 workerPorts.push(channel.port1);
                 this.workersStatus.push({
                     worker: worker,
@@ -346,7 +346,7 @@ export class DPUClient {
         for (let index = 0; index < maxWorker; index++) {
             const channel = new MessageChannel();
             const worker = new Worker(new URL("workerUploadChildFile", import.meta.url));
-            worker.postMessage({ port: channel.port2 }, [channel.port2]);
+            worker.postMessage({ port: channel.port2, baseURL: dpuConfig.getBaseURL() }, [channel.port2]);
             workerPorts.push(channel.port1);
             this.workersStatus.push({
                 worker: worker,
@@ -463,6 +463,7 @@ export class DPUClient {
                     requestId: data.requestId,
                     dataUploadId: data.dataUploadId,
                     fileName: data.fileName,
+                    baseURL: dpuConfig.getBaseURL(),
                 };
                 worker.postMessage(newData, [data.arrayBuffer]);
                 // Cleanup abort handler when promise resolves or rejects
@@ -478,7 +479,7 @@ export class DPUClient {
     }
     //#endregion
     //#region Upload folder
-    async uploadFolderAferInit(filesInitiated, cancellationToken, worker, dataUploadId, onProgress, maxWebWorker) {
+    async uploadFolderAfterInit(filesInitiated, cancellationToken, worker, dataUploadId, onProgress, maxWebWorker) {
         const bucketName = filesInitiated[0].path.split("/").at(0);
         if (!bucketName)
             return new Promise((resolve, reject) => {
@@ -690,7 +691,7 @@ export class DPUClient {
             for (let index = 0; index < maxWorker; index++) {
                 const channel = new MessageChannel();
                 const worker = new Worker(new URL("workerUploadSingleFile", import.meta.url));
-                worker.postMessage({ port: channel.port2 }, [channel.port2]);
+                worker.postMessage({ port: channel.port2, baseURL: dpuConfig.getBaseURL() }, [channel.port2]);
                 workerPorts.push(channel.port1);
                 this.workersStatus.push({
                     worker: worker,
@@ -821,6 +822,7 @@ export class DPUClient {
                     isGetInfo: request.isGetInfo,
                     preSignUrl: request.preSignUrl,
                     dataUploadId: request.dataUploadId,
+                    baseURL: dpuConfig.getBaseURL(),
                 };
                 worker.postMessage(newData, [request.arrayBuffer]);
                 // Cleanup abort handler when promise resolves or rejects

package/dist/workerUploadChildFile.js

@@ -1,12 +1,17 @@
 import { ApiStatus } from "./utils/Constants";
 import { Buffer } from "buffer";
 import { StatusWorker } from "./utils/Enum";
+import { dpuConfig } from "./utils/Config";
 let abortController = null;
 let workerPortRoot = null;
 self.onmessage = async (message) => {
     const { data } = message;
     if (data.port) {
         workerPortRoot = data.port;
+        // Set baseURL if provided
+        if (data.baseURL) {
+            dpuConfig.setBaseURL(data.baseURL);
+        }
     }
     else {
         // Handle abort message

package/dist/workerUploadSingleFile.js

@@ -2,6 +2,7 @@ import { ConfigFileRules } from "./utils/Constants";
 import { Buffer } from "buffer";
 import { StatusWorker } from "./utils/Enum";
 import { ServiceIntegration } from "./ServiceIntegration";
+import { dpuConfig } from "./utils/Config";
 let abortController = null;
 let workerPortRoot = null;
 // tạm thời chưa làm phần token
@@ -9,6 +10,10 @@ self.onmessage = async (message) => {
     const { data } = message;
     if (data.port) {
         workerPortRoot = data.port;
+        // Set baseURL if provided
+        if (data.baseURL) {
+            dpuConfig.setBaseURL(data.baseURL);
+        }
     }
     else {
         // Handle abort message

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "dpu-cloud-sdk",
-  "version": "1.0.0",
+  "version": "1.0.1",
   "main": "dist/index",
   "types": "dist/index",
   "scripts": {

package/src/DPUClient.ts

@@ -343,7 +343,7 @@ export class DPUClient {
         const worker = new Worker(
           new URL("workerUploadChildFile", import.meta.url)
         );
-        worker.postMessage({ port: channel.port2 }, [channel.port2]);
+        worker.postMessage({ port: channel.port2, baseURL: dpuConfig.getBaseURL() }, [channel.port2]);
         workerPorts.push(channel.port1);
         this.workersStatus.push({
           worker: worker,
@@ -585,7 +585,7 @@ export class DPUClient {
       const worker = new Worker(
         new URL("workerUploadChildFile", import.meta.url)
       );
-      worker.postMessage({ port: channel.port2 }, [channel.port2]);
+      worker.postMessage({ port: channel.port2, baseURL: dpuConfig.getBaseURL() }, [channel.port2]);
       workerPorts.push(channel.port1);
       this.workersStatus.push({
         worker: worker,
@@ -728,6 +728,7 @@ export class DPUClient {
           requestId: data.requestId,
           dataUploadId: data.dataUploadId,
           fileName: data.fileName,
+          baseURL: dpuConfig.getBaseURL(),
         };
         worker.postMessage(newData, [data.arrayBuffer]);
 
@@ -746,7 +747,7 @@ export class DPUClient {
   }
   //#endregion
   //#region Upload folder
-  public async uploadFolderAferInit(
+  public async uploadFolderAfterInit(
     filesInitiated: {
       file: File;
       fileKey: string;
@@ -1096,7 +1097,7 @@ export class DPUClient {
         const worker = new Worker(
           new URL("workerUploadSingleFile", import.meta.url)
         );
-        worker.postMessage({ port: channel.port2 }, [channel.port2]);
+        worker.postMessage({ port: channel.port2, baseURL: dpuConfig.getBaseURL() }, [channel.port2]);
         workerPorts.push(channel.port1);
         this.workersStatus.push({
           worker: worker,
@@ -1254,6 +1255,7 @@ export class DPUClient {
           isGetInfo: request.isGetInfo,
           preSignUrl: request.preSignUrl,
           dataUploadId: request.dataUploadId,
+          baseURL: dpuConfig.getBaseURL(),
         };
         worker.postMessage(newData, [request.arrayBuffer]);
 

package/src/workerUploadChildFile.ts

@@ -1,6 +1,7 @@
 import { ApiStatus } from "./utils/Constants";
 import { Buffer } from "buffer";
 import { StatusWorker } from "./utils/Enum";
+import { dpuConfig } from "./utils/Config";
 
 let abortController: AbortController | null = null;
 let workerPortRoot: MessagePort | null = null;
@@ -9,6 +10,10 @@ self.onmessage = async (message) => {
   const { data } = message;
   if (data.port) {
     workerPortRoot = data.port;
+    // Set baseURL if provided
+    if (data.baseURL) {
+      dpuConfig.setBaseURL(data.baseURL);
+    }
   } else {
     // Handle abort message
     if (data.type === "abort") {

package/src/workerUploadSingleFile.ts

@@ -2,6 +2,7 @@ import { ConfigFileRules, ApiStatus } from "./utils/Constants";
 import { Buffer } from "buffer";
 import { StatusWorker } from "./utils/Enum";
 import { ServiceIntegration } from "./ServiceIntegration";
+import { dpuConfig } from "./utils/Config";
 
 let abortController: AbortController | null = null;
 let workerPortRoot: MessagePort | null = null;
@@ -11,6 +12,10 @@ self.onmessage = async (message) => {
   const { data } = message;
   if (data.port) {
     workerPortRoot = data.port;
+    // Set baseURL if provided
+    if (data.baseURL) {
+      dpuConfig.setBaseURL(data.baseURL);
+    }
   } else {
     // Handle abort message
     if (data.type === "abort") {