@mecode-asia/do-module

DO Module

A module used for interact with Digital Ocean services

• DO Spaces

DO Spaces

This module allow user to:

• Generate pre-signed url to upload file to Digital Ocean spaces (or any S3 compatible storage)
• Generate view link for privately uploaded files
• Generate public view link for publicly uploaded files
• Delete a file from the storage

Usage

• Install this library by running

yarn add @mecode-asia/do-module

Your NestJS application requires:

• ConfigModule - For reading ENVs as config service. Installation guide

• These ENVs (either in .env file or exported as ENV variable)

SPACES_ENDPOINT=https://sgp1.digitaloceanspaces.com/ # endpoint of your space
SPACES_REGION=sgp1 # region of your space
SPACES_NAME=<name of your space>
SPACES_KEY=<your space access key>
SPACES_SECRET=<your space secret key>

• Import DoModule into your AppModule

import { DoModule } from '@mecode-asia/do-module';

@Module({
  imports: [ConfigModule.forRoot(), DoModule],
  controllers: [AppController],
  providers: [AppService],
})
export class AppModule {}

• Inject SpacesService into your controller and use it.

@Controller()
export class AppController {
  constructor(private readonly spacesService: SpacesService) {}

  @Get()
  async genUploadLink(): Promise<string> {
    const { url } = await this.spacesService.generateUploadLink(
      'test.jpeg',
      'image/jpeg',
    );
    return url;
  }
}

The pre-signed url is creating a private file by default. To upload as public file, add this header when uploading the file with the pre-signed url

x-amz-acl: 'public-read'

For example with Axios:

const { status } = await axios.put(presignedUrl, file, {
  'x-amz-acl': 'public-read',
});

API reference

SpacesService

generateUploadLink takes file name and file content type and generate a presigned url for file upload. To ensure uniqueness of the file, the name is suffixed with unix timestamp.

It returns presigned url with suffixed filename.

generateViewLink takes suffixed name, content type and isDownload and generate link to access the private file which expired in 5 hours

If isDownload is true, the file will be downloaded automatically when accessing the link on a browser. If not, the link view preview the on the browser directly.

deleteFile takes suffixed name, content type. It deletes the file from the storage.

getPublicUrl takes the suffixed file name and returns a publicly accessible link.