cyberlake: Secure 3D Asset Management for Metabees

A tranquil oasis for managing your 3D assets on the Metabees platform.

This package provides a trio of powerful functions to streamline your workflow within the Metabees ecosystem (Metabees.in):

1. userConfig(email, cyberlakeKey):

• Purpose: Authenticates a user and retrieves their configuration data from the Cyber Lake platform, granting access to their 3D asset storage.
• Usage:

JavaScript

import { userConfig } from '@metabees/cyberlake';

const userEmail = '[email protected]';
const cyberlakeKey = 'your_unique_cyberlake_key'; // Obtain from your Metabees dashboard

async function setUser(){
    await userConfig({email:userEmail, cyberlakeKey:cyberlakeKey});
}
setUser();

Use code with caution.

2. uploadFile(fileOrPath, fileName, passcode):

• Purpose: Uploads a 3D asset file to your secure Cyber Lake storage within Metabees, encrypting it with a user-provided passcode for enhanced security.
• Usage:

Using a File object:

JavaScript

import { uploadFile } from '@metabees/cyberlake';

const fileToUpload = document.getElementById('fileInput').files[0]; // Assuming a file input element
const fileName = fileToUpload.name;
const passcode = 'your_strong_encryption_passcode';

async function main(){
    await uploadFile({file: fileToUpload, fileName: fileName, passcode: passcode});
} 

main();

Use code with caution.

Using fs.readFileSync (Node.js only):

JavaScript

import { uploadFile } from '@metabees/cyberlake';
import fs from 'fs';

const filePath = '/path/to/your/3d_asset.obj'; // Replace with your actual file path
const fileName = '3d_asset.obj'; // Adjust filename if needed
const passcode = 'your_strong_encryption_passcode';

const fileContent = fs.readFileSync(filePath);

async function main(){
    await uploadFile({file: fileContent, fileName: fileName, passcode: passcode});
} 

main();

Use code with caution.

3. downloadFile(fileName, passcode):

• Purpose: Downloads a previously uploaded 3D asset from your Cyber Lake storage within Metabees, decrypting it using the provided passcode for access.
• Usage:

JavaScript

import { downloadFile } from '@metabees/cyberlake';

const uploadedFileName = 'my_encrypted_3d_asset.obj';
const passcode = 'your_encryption_passcode';


async function main(){
    const downloadUrl = await downloadFile({fileName:uploadedFileName, passcode: passcode});
    console.log("Download link for your Cyberlake file => ",downloadUrl);
} 

main();

Use code with caution.

Installation

Bash

npm install @metabees/cyberlake

Use code with caution.

Contributing

We welcome contributions to this package! Please refer to the CONTRIBUTING.md file for guidelines on how to get involved.

License

This project is licensed under the ISC License.

Remember:

• Replace placeholders like your_unique_cyberlake_key and your_strong_encryption_passcode with your actual values.
• Adapt the file selection mechanism based on your implementation.
• Refer to the Metabees.in platform for further details on managing your 3D assets.

This README.md provides a beautiful and informative overview of the cyberlake package, empowering you to seamlessly manage your 3D assets within the Metabees ecosystem.