File-storage

[![npm][npm-image]][npm-url]

[npm-image]: https://img.shields.io/npm/v/@getlarge/nestjs-tools-file-storage.svg?style=flat
[npm-url]: https://npmjs.org/package/@getlarge/nestjs-tools-file-storage

This module provide a unified API to store files in different storage providers.

Supoorted backends:

- Node FileSystem
- AWS S3
- Google Cloud Storage

Installation

``bash
npm install --save @getlarge/nestjs-tools-file-storage
`

Example

`ts
// module.ts
import { Module } from '@nestjs/common';
import { ConfigModule, ConfigService } from '@nestjs/config';
import { FileStorageLocal, FileStorageModule, FileStorageS3 } from '@getlarge/nestjs-tools-file-storage';

import { AppService } from './env';

@Module({
imports: [
ConfigModule.forRoot({
isGlobal: true,
}),
FileStorageModule.forRootAsync({
inject: [ConfigService],
useFactory: (configService: ConfigService) => {
const environment = configService.get('NODE_ENV', { infer: true });
if (environment === 'development') {
const setup = {
storagePath: configService.get('STORAGE_PATH'),
maxPayloadSize: configService.get('MAX_PAYLOAD_SIZE'),
};
return new FileStorageLocal(setup);
}
const setup = {
maxPayloadSize: configService.get('MAX_PAYLOAD_SIZE'),
bucket: configService.get('AWS_S3_BUCKET'),
region: configService.get('AWS_S3_REGION'),
credentials: {
accessKeyId: configService.get('AWS_S3_ACCESS_KEY_ID'),
secretAccessKey: configService.get('AWS_S3_SECRET_ACCESS_KEY'),
},
};
return new FileStorageS3(setup);
},
}),
],
providers: [AppService],
})
export class AppModule {}
`

`ts
// service.ts
import { FileStorageService } from '@getlarge/nestjs-tools-file-storage';
import { Inject, Injectable, Logger } from '@nestjs/common';
import { ConfigService } from '@nestjs/config';

@Injectable()
export class AppService {
constructor(
@Inject(ConfigService) private readonly configService: ConfigService,
@Inject(FileStorageService)
private readonly fileStorageService: FileStorageService,
) {}

getFile(filePath: string): Promise {
return this.fileStorage.downloadFile({ filePath });
}

setFile(filePath: string, content: string): Promise {
return this.fileStorage.uploadFile({
filePath,
content,
});
}

deleteFile(filePath: string): Promise {
return this.fileStorage.deleteFile({ filePath });
}
}
`

Testing

To run the tests, you need to have a .env.test file in the root of the project following the structure of the .env.test.sample file.
You should also authenticate to external services.

$3

I highly recommend configuring the AWS Identity Center to manage your AWS credentials for development.

> Note:
> You can use the aws CLI to authenticate, find more information here.

Once authenticated:

- set the AWS_PROFILE environment variable to the profile you want to use
- or set the AWS_S3_ACCESS_KEY_ID and AWS_S3_SECRET_ACCESS_KEY environment variables.

$3

The recommended approach is to setup Application Default Credentials.

> Note:
> You can use the gcloud CLI to authenticate, more information here.

Troubleshooting

If, after upgrading, you get the following error:

`sh
/usr/local/bin/node[57897]: ../src/node_http_parser.cc:517:static void node::(anonymous namespace)::Parser::Execute(const FunctionCallbackInfo &): Assertion parser->current_buffer_.IsEmpty()' failed.
``

You need to update to node v18.6 or higher. This is due to an issue with the node http` module.
More information can be found here and here.