ConvergeERP.Shared.Documents.S3 0.0.1-beta

ConvergeERP.Shared.Documents.S3

AWS S3 adapter for document storage in ConvergeERP applications.

Installation

dotnet add package ConvergeERP.Shared.Documents.S3

Configuration

Add to appsettings.json:

{
  "AWS": {
    "S3": {
      "BucketName": "your-bucket-name",
      "Region": "us-east-1",
      "UploadUrlExpirationSeconds": 3600,
      "DownloadUrlExpirationSeconds": 3600,
      "MaxFileSizeBytes": 52428800,
      "KeyPrefix": "documents/"
    }
  }
}

For LocalStack/MinIO (Development)

{
  "AWS": {
    "S3": {
      "BucketName": "local-bucket",
      "Region": "us-east-1",
      "ServiceUrl": "http://localhost:4566",
      "ForcePathStyle": true
    }
  }
}

Setup

In Program.cs:

using ConvergeERP.Shared.Documents.S3.Extensions;

builder.Services.AddS3FileStorage(builder.Configuration);

Or with inline configuration:

builder.Services.AddS3FileStorage(options =>
{
    options.BucketName = "my-bucket";
    options.Region = "eu-west-1";
});

Usage

public class UploadController : ControllerBase
{
    private readonly IFileStorageService _storage;

    public UploadController(IFileStorageService storage)
    {
        _storage = storage;
    }

    [HttpPost("request-upload")]
    public async Task<IActionResult> RequestUpload(
        [FromBody] RequestUploadDto dto,
        [FromHeader] Guid companyId)
    {
        // Generate pre-signed URL for direct client upload
        var result = await _storage.GenerateUploadUrlAsync(
            companyId,
            dto.FileName,
            dto.ContentType);

        return Ok(new
        {
            uploadUrl = result.UploadUrl,
            fileKey = result.FileKey,
            expiresAt = result.ExpiresAt
        });
    }

    [HttpGet("download/{fileKey}")]
    public async Task<IActionResult> GetDownloadUrl(string fileKey)
    {
        var url = await _storage.GenerateDownloadUrlAsync(fileKey);
        return Ok(new { downloadUrl = url });
    }
}

Upload Flow

1. Client requests upload URL via your API
2. Your API generates pre-signed URL using GenerateUploadUrlAsync
3. Client uploads file directly to S3 using pre-signed URL
4. Client confirms upload completion to your API
5. Your API verifies file exists using FileExistsAsync

Related Packages

• ConvergeERP.Shared.Documents.Core - Core interfaces and entities
• ConvergeERP.Shared.Documents - EF Core implementation