@devino.solutions/upup

upup

Upup is an open-source, free-to-use Full-stack library that easily handles your file upload needs with seamless DigitalOcean Spaces, Amazon S3, Backblaze, Microsoft Azure Blob Storage, Google Drive, and OneDrive integrations.

🎮 Join our Discord, where we can provide quick support: Discord Invite Link

Installation

Install upup with your favourite package manager

npm

npm install @devino.solutions/upup

yarn

yarn add @devino.solutions/upup

pnpm

pnpm add @devino.solutions/upup

bun

bun install @devino.solutions/upup

Logic Diagram

This logic diagram explains how the client and server parts of the upup package works

Usage

The example below shows a minimal configuration for AWS S3 upload, using the UpupUploader client component and the s3GeneratePresignedUrl utility. For full code examples check these docs

Client Side

import { UpupUploader, UpupProvider } from '@bassem97/upup'

export default function Uploader() {
    return (
        <UpupUploader
            provider={UpupProvider.AWS} // assuming we are uploading to AWS
            tokenEndpoint="http://<path_to_your_server>/api/upload-token" // Path to your server route that calls our exported upload utilities
        />
    )
}

The UpupUploader must be placed in a client component.

Then use it in your application:

import Uploader from '<path_to_your_uploader_component>'

export default function App() {
    return <Uploader />
}

provider and tokenEndpoint are the only required props for the UpupUploader component. For a full list of component props, check out these docs.

Server Side

import { s3GeneratePresignedUrl } from '@devino.solutions/upup/server'

app.post('/api/upload-token', async (req, res) => {
    try {
        const { provider, ...fileParams } = req.body // The request body sent from the `UpupUploader` client component
        const origin = req.headers['origin'] // The origin of your client application

        // Generate presigned URL
        const presignedData = await s3GeneratePresignedUrl({
            origin: origin as string,
            provider,
            fileParams,
            bucketName: process.env.AWS_BUCKET_NAME as string,
            s3ClientConfig: {
                region: process.env.AWS_REGION as string,
                credentials: {
                    accessKeyId: process.env.AWS_ACCESS_KEY_ID as string,
                    secretAccessKey: process.env
                        .AWS_SECRET_ACCESS_KEY as string,
                },
            },
        })

        return res.status(200).json({
            data: presignedData,
            message: 'Upload successful!',
            error: false,
        })
    } catch (error) {
        return res.status(500).json({
            message: (error as Error).message,
            error: true,
        })
    }
})

Once again, the example shown above is the minimal required configuration for AWS S3 upload. For uploading to other services see these docs

Important Note

It is important to note that while it is possible to:

• Implement your own custom logic on the client and use the server utilities provided by this component on the server OR
• Use the UpupUploader React component on the client and implement your own custom server logic to handle uploads,

For best performance and minimal overhead, we advise that you use both the UpupUploader React component together with the server utilities, like s3GeneratePresignedUrl

The full list of exported server utility functions include:

• s3GeneratePresignedUrl: for S3-compatible Uploads: like AWS, Digital Ocean, Backblaze
• azureGenerateSasUrl: for Azure Blob Uploads only

For a full list of values sent by the React component to the server, check out these docs.

All done! 🎉

Documentation

Find the full API reference and guides in the official documentation.

Contributing

Please read our Contributing Guidelines before submitting pull requests. All contributions fall under our Code of Conduct.

Security

For security concerns, please review our Security Policy.

License

This project is licensed under the MIT License - see the LICENSE file for details.

Made with ❤️ by Devino