jpalumickas / uplo

Handle file uploads to different storage services like Amazon S3, Google Cloud or etc. It also supports different type of ORM adapters, like Prisma.

Uplo

Handle file uploads to various storage services like Amazon S3, Google Cloud or etc. It also supports various type of ORM adapters, like Prisma.

Features

• TypeScript ready
• Direct uploads
• Supports multiple services
• Multiple ORM adapters
• File analyzers

Getting started

Add @uplo/node to your package.json

yarn add @uplo/node

Install Adapter (for example Prisma)

yarn add @uplo/adapter-prisma dataloader

Install Service (for example S3)

yarn add @uplo/service-s3

Define uplo instance

import Uplo from '@uplo/node';
import PrismaAdapter from '@uplo/adapter-prisma';
import GCSService from '@uplo/service-gcs';

const config = {
  privateKey: process.env.APPLICATION_SECRET, // Used to sign direct upload keys
  signedIdExpiresIn: 60 * 60, // Time how long a Signed ID is valid
};

const uplo = Uplo({
  config,
  adapter: new PrismaAdapter({ prisma }),
  services: {
    s3: S3Service({
      isPublic: false,
      region: process.env.AWS_REGION,
      bucket: process.env.AWS_BUCKET,
      accessKeyId: '*****',
      secretAccessKey: '*****',
    }),
  },
  attachments: {
    user: {
      avatar: true, // pass true to use default options
    },
    post: {
      images: { multiple: true }
    }
  },
});

const attachment = await uplo.attachments.user(123).avatar.attachFile(await blobFileInput({
  path: '/home/images/image.png'
}))

License

The package is available as open source under the terms of the MIT License.

uplo's Issues

Allow to copy blob to different service

This might be useful if we want to backup blobs to separate service. For example: run background job to copy Blob to Glacier after file attached to S3.

Allow to move blob to different service

This might be useful if we change services (for example from GCP to S3) and we want to move blobs

Add edge runtime support

I've tried using it on Vercel edge runtime, but it fails since it uses tempy and other node-specific libs. Would be nice to run it on edge functions.

Example on how to use with react/nextjs alongside prisma?

Looks super interesting, thanks for open sourcing, any plans on supporting react via @uplo/react or something similar? Thank you!

[@uplo/service-gcs] Uint8Array not implemented but looks supported ?

Hi !

I don't know if i'm doing something wrong but in Bun I do :

await uplo.attachments.user(user.id).avatar.attachFile({
            fileName: file.name,
            content: Buffer.from(await file.arrayBuffer()),
            contentType: file.type
          })

The problem is:
Buffer.from(await file.arrayBuffer()) instanceof Uint8Array returns true

So it throws because of this:

} else if (content instanceof Uint8Array) {
  throw new Error("Uint8Array not implemented");
}

If I comment it, the file is uploaded properly tho, is there any reason you can't send a Buffer to GCS ?