SAMMAI.Transverse 0.18.0-beta

SAMMAI.Transverse

Overview

SAMMAI.Transverse is a foundational .NET 8 class library designed as a cross-cutting concerns package for the SAMMAI ecosystem. This NuGet package provides essential utilities, clients, and helpers that can be consumed by various .NET 8 WebAPI projects within the SAMMAI platform.

Features

• Global Configuration: Centralized configuration management
• HTTP Clients: Pre-configured HTTP services for various SAMMAI services
• Helpers: Utility classes for common operations
• Constants & Enums: Shared constants and enumerations
• DTOs & Models: Common data transfer objects and models
• Authentication: Authentication and authorization utilities
• Logging: Structured logging with Serilog integration
• Caching: In-memory caching helpers
• Actions Filters: Predefined action filters for controllers
• Database Access: Simplified database client utilities
• Forms & Reports: Clients for handling forms and reports
• Resource Management: Utilities for managing resources
• User Preferences: Client for user preferences management
• Modular Design: Enable only the components you need
• Extensible: Easily extendable for custom implementations
• Compatibility: Compatible with .NET 8 applications
• Integration Ready: Easily integrates with existing SAMMAI services

Installation

Add the NuGet package to your project:

<PackageReference Include="SAMMAI.Transverse" Version="1.0.0" />

Implementation

In your Program.cs, activate the required services:

// Basic setup
services.AddTransverseServices();

// Additional services (enable as needed)
services.AddTransverseServices(configuration, opt =>
{
    opt.ActivateAuthenticationClient = true;
    opt.ActivateEventClient = true;
    opt.ActivateEmailHelper = true;
    opt.ActivateCacheHelper = true;
    opt.ActivateDataBaseClient = true;
    opt.ActivateCustomDataClient = true;
    opt.ActivateFormsClient = true;
    opt.ActivateReportClient = true;
    opt.ActivateResourcesClient = true;
    opt.ActivatePreferencesClient = true;
});

Adding the Local Package Source

To access this NuGet package, execute the following command to add the local package source:

dotnet nuget add source "<physical-root-path-of-this-folder>\SAMMAI.NuGet" -n "SAMMAI Local Package Source"

Dependencies

• AutoMapper - Object-to-object mapping
• FluentValidation - Validation framework
• Microsoft.AspNetCore.Mvc - ASP.NET Core MVC framework
• Microsoft.Extensions.Http - HTTP client factory
• Microsoft.VisualStudio.Azure.Containers.Tools.Targets - Container tooling support
• Serilog - Structured logging
• Serilog.Extensions.Hosting - Hosting integration for Serilog
• Serilog.Settings.Configuration - Configuration support for Serilog
• Serilog.Sinks.Console - Console logging output
• Serilog.Sinks.File - File logging output
• Serilog.Sinks.Http - HTTP logging output
• Swashbuckle.AspNetCore - API documentation (Swagger)

External Services

ExternalServices - HTTP service clients for various SAMMAI services:

• AuthenticationHttpService
• CustomDataHttpService
• DataBaseHttpService
• FileStorageHttpService
• MessengerHttpService
• ReportServiceHttpService
• SignHttpService

Package Versions

All versions of this package are available on NuGet:

https://www.nuget.org/packages/SAMMAI.Transverse

Usage

The library provides a modular approach where you can enable only the components you need for your specific application.

Support

For issues and questions regarding SAMMAI.Transverse, please refer to the project documentation or contact the SAMMAI development team.

Part of the SAMMAI Ecosystem - Building consistent .NET 8 applications