ConvergeERP.Shared.Documents.Core 0.0.1-beta

This is a prerelease version of ConvergeERP.Shared.Documents.Core.
dotnet add package ConvergeERP.Shared.Documents.Core --version 0.0.1-beta
                    
NuGet\Install-Package ConvergeERP.Shared.Documents.Core -Version 0.0.1-beta
                    
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="ConvergeERP.Shared.Documents.Core" Version="0.0.1-beta" />
                    
For projects that support PackageReference, copy this XML node into the project file to reference the package.
<PackageVersion Include="ConvergeERP.Shared.Documents.Core" Version="0.0.1-beta" />
                    
Directory.Packages.props
<PackageReference Include="ConvergeERP.Shared.Documents.Core" />
                    
Project file
For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package.
paket add ConvergeERP.Shared.Documents.Core --version 0.0.1-beta
                    
#r "nuget: ConvergeERP.Shared.Documents.Core, 0.0.1-beta"
                    
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
#:package ConvergeERP.Shared.Documents.Core@0.0.1-beta
                    
#:package directive can be used in C# file-based apps starting in .NET 10 preview 4. Copy this into a .cs file before any lines of code to reference the package.
#addin nuget:?package=ConvergeERP.Shared.Documents.Core&version=0.0.1-beta&prerelease
                    
Install as a Cake Addin
#tool nuget:?package=ConvergeERP.Shared.Documents.Core&version=0.0.1-beta&prerelease
                    
Install as a Cake Tool

ConvergeERP.Shared.Documents.Core

Core abstractions for document management in ConvergeERP applications.

Contents

  • Entities: Document, DocumentFile, DocumentCategory
  • Interfaces: IFileStorageService for storage abstraction
  • DTOs: Request/response models for document operations
  • Events: Integration events for event-driven architectures
  • Enums: DocumentStatus, FileUploadStatus

Usage

This package contains only interfaces, entities, and contracts. For the implementation, install:

  • ConvergeERP.Shared.Documents - EF Core implementation
  • ConvergeERP.Shared.Documents.S3 - AWS S3 storage adapter
// Inject the storage service
public class MyService
{
    private readonly IFileStorageService _storage;

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

    public async Task<string> UploadEmployeeDocument(Guid companyId, IFormFile file)
    {
        // Generate pre-signed upload URL
        var result = await _storage.GenerateUploadUrlAsync(
            companyId, 
            file.FileName, 
            file.ContentType);
        
        return result.UploadUrl;  // Client uploads directly to S3
    }
}

Two-Phase Upload Flow

  1. Request upload URL: Client requests a pre-signed URL
  2. Direct upload: Client uploads file directly to storage (S3)
  3. Confirm upload: Client confirms upload, file is verified and linked

This flow avoids proxying file bytes through your API, reducing server load.

Product Compatible and additional computed target framework versions.
.NET net10.0 is compatible.  net10.0-android was computed.  net10.0-browser was computed.  net10.0-ios was computed.  net10.0-maccatalyst was computed.  net10.0-macos was computed.  net10.0-tvos was computed.  net10.0-windows was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages (2)

Showing the top 2 NuGet packages that depend on ConvergeERP.Shared.Documents.Core:

Package Downloads
ConvergeERP.Shared.Documents.S3

AWS S3 implementation of IFileStorageService for document management. Supports pre-signed URLs, direct upload/download, and S3-compatible storage.

ConvergeERP.Shared.Documents

EF Core implementation of document management. Includes entity configurations, repositories, and DI extensions.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last Updated
0.0.1-beta 96 6/19/2026