BossCloudMedia

BossCloudMedia is a simple yet powerful Node.js package for cloud file operations using AWS S3. It provides an easy-to-use interface for uploading, deleting, and listing files in the cloud.

Installation

Install the package using npm:

npm install bosscloudmedia

Generating an API Key

To use BossCloudMedia, you'll need an API key. Follow these steps to obtain one:

1. Compose an email to [email protected]
2. Include the following information in your email:
   • Subject: "API Key Request for BossCloudMedia"
   • Body: Your company name
   • Any specific requirements or questions you may have

The BossCloudMedia team will review your request and provide you with an API key along with any additional instructions or information.

Usage

Initializing BossCloudMedia

Once you have your API key, import and initialize the BossCloudMedia class:

const BossCloudMedia = require('bosscloudmedia');

const cloudMedia = new BossCloudMedia({ api_key: 'your_api_key_here' });

Uploading a Single File

To upload a single file, use the upload method:

async function uploadSingleFile() {
  try {
    const filePath = '/path/to/your/file.jpg';
    const fileName = 'image.jpg';
    const fileBuffer = await fs.promises.readFile(filePath);
    
    const result = await cloudMedia.upload(fileBuffer, fileName);
    console.log('Upload successful:', result);
  } catch (error) {
    console.error('Upload failed:', error);
  }
}

uploadSingleFile();

You can also upload a file from a URL:

async function uploadFromURL() {
  try {
    const imageUrl = 'https://example.com/image.jpg';
    const fileName = 'image_from_url.jpg';
    
    const result = await cloudMedia.upload(imageUrl, fileName);
    console.log('Upload from URL successful:', result);
  } catch (error) {
    console.error('Upload from URL failed:', error);
  }
}

uploadFromURL();

Uploading Multiple Files

To upload multiple files, use the uploadMultiple method:

async function uploadMultipleFiles() {
  try {
    const files = [
      { buffer: await fs.promises.readFile('/path/to/file1.jpg'), name: 'file1.jpg' },
      { buffer: await fs.promises.readFile('/path/to/file2.png'), name: 'file2.png' },
      { url: 'https://example.com/image.jpg', name: 'file3.jpg' }
    ];
    
    const inputs = files.map(file => file.buffer || file.url);
    const fileNames = files.map(file => file.name);
    
    const results = await cloudMedia.uploadMultiple(inputs, fileNames);
    console.log('Multiple uploads results:', results);
  } catch (error) {
    console.error('Multiple uploads failed:', error);
  }
}

uploadMultipleFiles();

Deleting a Single File

To delete a single file, use the delete method:

async function deleteSingleFile() {
  try {
    const fileName = 'file_to_delete.jpg';
    const result = await cloudMedia.delete(fileName);
    console.log('Deletion successful:', result);
  } catch (error) {
    console.error('Deletion failed:', error);
  }
}

deleteSingleFile();

Deleting Multiple Files

To delete multiple files, pass an array of file names to the delete method:

async function deleteMultipleFiles() {
  try {
    const fileNames = ['file1.jpg', 'file2.png', 'file3.jpg'];
    const results = await cloudMedia.delete(fileNames);
    console.log('Multiple deletions results:', results);
  } catch (error) {
    console.error('Multiple deletions failed:', error);
  }
}

deleteMultipleFiles();

Listing All Files

To retrieve a list of all files in your cloud storage, use the listFiles method:

async function listAllFiles() {
  try {
    const files = await cloudMedia.listFiles();
    console.log('Files in storage:', files);
  } catch (error) {
    console.error('Failed to list files:', error);
  }
}

listAllFiles();

Error Handling

All methods may throw errors. It's important to use try-catch blocks to handle these errors gracefully:

async function errorHandlingExample() {
  try {
    // Trying to upload an invalid file
    await cloudMedia.upload(null, 'invalid.jpg');
  } catch (error) {
    console.error('Expected error:', error.message);
  }

  try {
    // Trying to delete with an invalid filename
    await cloudMedia.delete('');
  } catch (error) {
    console.error('Expected error:', error.message);
  }
}

errorHandlingExample();

API Reference

new BossCloudMedia(config)

Creates a new instance of BossCloudMedia.

Parameters:

• config (Object): Configuration object
  • api_key (String): Your API key for authentication

cloudMedia.upload(input, fileName)

Uploads a single file to the cloud storage.

Parameters:

• input (Buffer | string): The file buffer or URL to upload
• fileName (string): The name to give the file in cloud storage

Returns:

• A Promise that resolves with the upload response (string URL of the uploaded file).

cloudMedia.uploadMultiple(inputs, fileNames)

Uploads multiple files to the cloud storage.

Parameters:

• inputs (Array<Buffer | string>): An array of file buffers or URLs to upload
• fileNames (Array): An array of file names corresponding to the inputs

Returns:

• A Promise that resolves with an array of upload results.

cloudMedia.delete(fileName)

Deletes a file or multiple files from the cloud storage.

Parameters:

• fileName (string | Array): The name of the file to delete, or an array of file names to delete multiple files

Returns:

• A Promise that resolves with the deletion response or an array of deletion responses.

cloudMedia.listFiles()

Retrieves a list of all files in the cloud storage.

Returns:

• A Promise that resolves with an array of file objects. Each object contains:
  • name (string): The name of the file
  • url (string): The URL of the file
  • lastModified (number): The last modified timestamp in milliseconds (UTC)
  • size (string): The size of the file in a human-readable format (e.g., "1.5 MB")

License

This project is licensed under the MIT License.