Kuwait.Lis.Common.Data 2.0.1

Kuwait.Lis.Common.Data

A .NET library providing common data access utilities for Kuwait LIS services.

Features

• Repository Pattern: Generic repository implementation with Dapper
• Database Connection Factory: SQL Server connection management
• Base Entity: Common entity base class with audit fields
• Stored Procedure Mapping: Parameter mapping helpers for stored procedures
• OData Translation: Convert OData query syntax to SQL
• Specification Pattern: Query specification support with Ardalis.Specification

Installation

Install the package via NuGet Package Manager:

dotnet add package Kuwait.Lis.Common.Data

Or via Package Manager Console:

Install-Package Kuwait.Lis.Common.Data

Usage

Repository Pattern

using Kuwait.Lis.Common.Data;

// Register in DI container
services.AddScoped<IDbConnectionFactory, SqlConnectionFactory>();
services.AddScoped<IRepository<MyEntity>, DapperRepository<MyEntity>>();

// Use in your service
public class MyService
{
    private readonly IRepository<MyEntity> _repository;
    
    public MyService(IRepository<MyEntity> repository)
    {
        _repository = repository;
    }
    
    public async Task<MyEntity> GetByIdAsync(int id)
    {
        return await _repository.GetByIdAsync(id);
    }
    
    public async Task<IEnumerable<MyEntity>> GetAllAsync()
    {
        return await _repository.GetAllAsync();
    }
}

Database Connection Factory

using Kuwait.Lis.Common.Data;

var connectionFactory = new SqlConnectionFactory("your-connection-string");
using var connection = connectionFactory.CreateConnection();

Base Entity

using Kuwait.Lis.Common.Data.Entities;

public class MyEntity : BaseEntity
{
    public string Name { get; set; }
    public string Description { get; set; }
    // CreatedDate, UpdatedDate, IsActive inherited from BaseEntity
}

Stored Procedure Parameter Mapping

using Kuwait.Lis.Common.Data.Helpers;

var parameters = StoredProcParamMapper.MapToParameters(myEntity);

OData Translation

using Kuwait.Lis.Common.Data;

// Convert OData filter to SQL WHERE clause
string odataFilter = "Name eq 'John' and Age gt 25";
string sqlWhere = ODataTranslator.TranslateFilter(odataFilter);
// Result: "Name = 'John' AND Age > 25"

// Convert OData orderby to SQL ORDER BY clause
string odataOrderBy = "Name asc, Age desc";
string sqlOrderBy = ODataTranslator.TranslateOrderBy(odataOrderBy);
// Result: "Name ASC, Age DESC"

Configuration

Add the following configuration to your appsettings.json:

{
  "ConnectionStrings": {
    "DefaultConnection": "Server=your-server;Database=your-database;Trusted_Connection=true;"
  }
}

Build and Package

To build the project and create NuGet package:

# Build the project
dotnet build --configuration Release

# Create NuGet package
dotnet pack --configuration Release --output ./packages

# Push to NuGet (optional)
dotnet nuget push ./packages/Kuwait.Lis.Common.Data.1.0.0.nupkg --api-key YOUR_API_KEY --source https://api.nuget.org/v3/index.json

Dependencies

• .NET 9.0
• Ardalis.Specification (8.0.0)
• Dapper (2.1.35)
• Microsoft.Data.SqlClient (5.2.2)
• Microsoft.Extensions.DependencyInjection.Abstractions (9.0.0)

License

MIT License