DRN.Framework.SharedKernel 0.5.1-preview001

Prefix Reserved
This is a prerelease version of DRN.Framework.SharedKernel.
There is a newer version of this package available.
See the version list below for details.
dotnet add package DRN.Framework.SharedKernel --version 0.5.1-preview001
                    
NuGet\Install-Package DRN.Framework.SharedKernel -Version 0.5.1-preview001
                    
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="DRN.Framework.SharedKernel" Version="0.5.1-preview001" />
                    
For projects that support PackageReference, copy this XML node into the project file to reference the package.
<PackageVersion Include="DRN.Framework.SharedKernel" Version="0.5.1-preview001" />
                    
Directory.Packages.props
<PackageReference Include="DRN.Framework.SharedKernel" />
                    
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 DRN.Framework.SharedKernel --version 0.5.1-preview001
                    
#r "nuget: DRN.Framework.SharedKernel, 0.5.1-preview001"
                    
#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 DRN.Framework.SharedKernel@0.5.1-preview001
                    
#: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=DRN.Framework.SharedKernel&version=0.5.1-preview001&prerelease
                    
Install as a Cake Addin
#tool nuget:?package=DRN.Framework.SharedKernel&version=0.5.1-preview001&prerelease
                    
Install as a Cake Tool

master develop Quality Gate Status

Security Rating Maintainability Rating Reliability Rating Vulnerabilities Bugs Lines of Code Coverage

DRN.Framework.SharedKernel package is an lightweight package that contains common codes suitable for contract and domain layers. It can be referenced by any projects such as other DRN.Framework packages, projects developed with DRN.Framework.

JsonConventions

System.Text.Json defaults will be overridden by JsonConventions when

  • TestContext is used in tests
  • DrnHostBuilder is used to build host
namespace DRN.Framework.SharedKernel.Json;

public static class JsonConventions
{
    private const string JsonHelpersFQN = "System.Net.Http.Json.JsonHelpers";
    private const string JsonHelpersOptions = "s_defaultSerializerOptions";
    private const string DefaultSerializerOptions = "s_defaultOptions";
    private const BindingFlags StaticPrivate = BindingFlags.Static | BindingFlags.NonPublic;

    static JsonConventions()
    {
        //https://stackoverflow.com/questions/58331479/how-to-globally-set-default-options-for-system-text-json-jsonserializer
        UpdateDefaultJsonSerializerOptions();
        UpdateHttpClientDefaultJsonSerializerOptions();
    }

    public static readonly JsonSerializerOptions DefaultOptions = SetJsonDefaults();
...
    /// <summary>
    ///   <para>Option values appropriate to Web-based scenarios.</para>
    ///   <para>This member implies that:</para>
    ///   <para>- Property names are treated as case-insensitive.</para>
    ///   <para>- "camelCase" name formatting should be employed.</para>
    ///   <para>- Quoted numbers (JSON strings for number properties) are allowed.</para>
    /// </summary>
    public static JsonSerializerOptions SetJsonDefaults(JsonSerializerOptions? options = null)
    {
        options ??= new JsonSerializerOptions(JsonSerializerDefaults.Web);
        options.Converters.Add(new JsonStringEnumConverter());
        options.AllowTrailingCommas = true;
        options.PropertyNameCaseInsensitive = true;
        options.PropertyNamingPolicy = JsonNamingPolicy.CamelCase;
        options.NumberHandling = JsonNumberHandling.AllowReadingFromString;

        return options;
    }
}

Exceptions

DrnException are used in DRN.Framework and DRN.Nexus and can be used any project. These exceptions contain additional category property so that same exception types can be differentiated with a subcategory. They also contain status code so that HttpScopeHandler can respect that.

ExceptionFor factory class groups all DrnExceptions.

namespace DRN.Framework.SharedKernel;

/// <summary>
/// DrnExceptions are handled by scope handler and can be used to short circuit the processing pipeline
/// </summary>
public abstract class DrnException(string message, Exception? ex, string? category, short? status = null)
    : Exception(message, ex)
{
    public const string DefaultCategory = "default";
    public string Category { get; } = category ?? DefaultCategory;
    public short Status { get; } = status ?? 500;
}

/// <summary>
/// Scope handler returns 400 when thrown
/// </summary>
public class ValidationException(string message, Exception? ex = null, string? category = null)
    : DrnException(message, ex, category, 400);
...
    
public static class ExceptionFor
{
    private const string Default = DrnException.DefaultCategory;

    /// <summary>
    /// Scope handler returns 400 when thrown
    /// </summary>
    public static ValidationException Validation(string message, Exception exception = null!, string? category = Default)
        => new(message, exception, category);

    /// <summary>
    /// Scope handler returns 401 when thrown
    /// </summary>
    public static UnauthorizedException Unauthorized(string message, Exception exception = null!, string? category = Default)
        => new(message, exception, category);

    /// <summary>
    /// Scope handler returns 403 when thrown
    /// </summary>
    public static ForbiddenException Forbidden(string message, Exception? exception = null, string? category = Default)
        => new(message, exception, category);

    /// <summary>
    /// Scope handler returns 404 when thrown
    /// </summary>
    public static NotFoundException NotFound(string message, Exception exception = null!, string? category = Default)
        => new(message, exception, category);

    /// <summary>
    /// Scope handler returns 409 when thrown
    /// </summary>
    public static ConflictException Conflict(string message, Exception exception = null!, string? category = Default)
        => new(message, exception, category);

    /// <summary>
    /// Scope handler returns 410 when thrown
    /// </summary>
    public static ExpiredException Expired(string message, Exception exception = null!, string? category = Default)
        => new(message, exception, category);

    /// <summary>
    /// Scope handler returns 500 when thrown
    /// </summary>
    public static ConfigurationException Configuration(string message, Exception? ex = null, string? category = Default)
        => new(message, ex, category);

    /// <summary>
    /// Scope handler returns 422 when thrown
    /// </summary>
    public static UnprocessableEntityException UnprocessableEntity(string message, Exception exception = null!, string? category = Default)
        => new(message, exception, category);

    /// <summary>
    /// To abort requests that doesn't even deserve a result
    /// </summary>
    public static MaliciousRequestException MaliciousRequest(string message, Exception exception = null!, string? category = Default)
        => new(message, exception, category);
}

Attributes

When an object, property, or field is annotated with the IgnoreLog attribute, the IScopeLog implementation detects this attribute and excludes the marked element from the log data.

[AttributeUsage(AttributeTargets.Class | AttributeTargets.Struct | AttributeTargets.Property | AttributeTargets.Field)]
public class IgnoreLogAttribute : Attribute;

public static class IgnoreLogExtensions
{
public static bool IgnoredLog(this object obj) => obj.GetType().GetCustomAttributes()
.Any(attribute => attribute.GetType() == typeof(IgnoreLogAttribute));

    public static bool IgnoredLog(this PropertyInfo info) =>
        info.PropertyType == typeof(object) ||
        info.GetCustomAttributes().Union(info.PropertyType.GetCustomAttributes())
            .Any(attribute => attribute.GetType() == typeof(IgnoreLogAttribute));
}

AppConstants

namespace DRN.Framework.SharedKernel;

public static class AppConstants
{
    public static int ProcessId { get; } = Environment.ProcessId;
    public static Guid ApplicationId { get; } = Guid.NewGuid();
    public static string EntryAssemblyName { get; } = Assembly.GetEntryAssembly()?.GetName().Name ?? "Entry Assembly Not Found";
    public static string TempPath { get; } = GetTempPath(); //Cleans directory at every startup
    public static string LocalIpAddress { get; } = GetLocalIpAddress();
...
}

Domain Base Definitions

Following definitions provide guidance and conventions for rapid and effective domain design. Their usage is not necessary however other framework features such as DrnContext benefits from them.

  • An entity should always have an long Id. It can have an additional ids.
  • All DateTime values should include offset
  • Entities should encapsulate their events
  • Entity status changes should be marked automatically by dbContext
  • Domain events should be published automatically by dbContext
namespace DRN.Framework.SharedKernel.Domain;

public abstract class AggregateRoot : Entity;

public abstract class Entity
{
    private List<IDomainEvent> DomainEvents { get; } = new();
    public IReadOnlyList<IDomainEvent> GetDomainEvents() => DomainEvents;
    public long Id { get; protected set; }

    [ConcurrencyCheck]
    public DateTimeOffset ModifiedAt { get; protected set; }
    public DateTimeOffset CreatedAt { get; protected set; }

    protected void AddDomainEvent(DomainEvent? e)
    {
        if (e != null) DomainEvents.Add(e);
    }

    public void MarkAsCreated()
    {
        CreatedAt = DateTimeOffset.UtcNow;
        ModifiedAt = DateTimeOffset.UtcNow;
        AddDomainEvent(GetCreatedEvent());
    }

    public void MarkAsModified()
    {
        ModifiedAt = DateTimeOffset.UtcNow;
        AddDomainEvent(GetModifiedEvent());
    }

    public void MarkAsDeleted()
    {
        AddDomainEvent(GetDeletedEvent());
    }

    protected abstract EntityCreated? GetCreatedEvent();
    protected abstract EntityModified? GetModifiedEvent();
    protected abstract EntityDeleted? GetDeletedEvent();

    private bool Equals(Entity other) => Id == other.Id;
    public override bool Equals(object? obj) => ReferenceEquals(this, obj) || obj is Entity other && Equals(other);
    public override int GetHashCode() => Id.GetHashCode();
    public static bool operator ==(Entity? left, Entity? right) => Equals(left, right);
    public static bool operator !=(Entity? left, Entity? right) => !Equals(left, right);
}
public interface IDomainEvent
{
    Guid Id { get; }
    DateTimeOffset Date { get; }
    long EntityId { get; }
    string EntityName { get; }
}

public abstract class DomainEvent(Entity entity) : IDomainEvent
{
    public Guid Id { get; protected init; } = Guid.NewGuid();
    public DateTimeOffset Date { get; protected init; } = DateTimeOffset.UtcNow;
    public long EntityId => entity.Id;
    public string EntityName { get; protected init; } = entity.GetType().FullName!;
}

public abstract class EntityCreated(Entity entity) : DomainEvent(entity);
public abstract class EntityModified(Entity entity) : DomainEvent(entity);
public abstract class EntityDeleted(Entity entity) : DomainEvent(entity);

Semper Progredi: Always Progressive

Commit Info

Author: Duran Serkan KILIÇ
Date: 2024-09-22 21:27:25 +0300
Hash: 5a1c8bb025cb41aef5138d4831359ed67c721257

Product Compatible and additional computed target framework versions.
.NET net8.0 is compatible.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed.  net9.0 was computed.  net9.0-android was computed.  net9.0-browser was computed.  net9.0-ios was computed.  net9.0-maccatalyst was computed.  net9.0-macos was computed.  net9.0-tvos was computed.  net9.0-windows was computed.  net10.0 was computed.  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.
  • net8.0

    • No dependencies.

NuGet packages (1)

Showing the top 1 NuGet packages that depend on DRN.Framework.SharedKernel:

Package Downloads
DRN.Framework.Utils

DRN.Framework.Utils package contains common codes for other DRN.Framework packages, projects developed with DRN.Framework. ## Commit Info Author: Duran Serkan KILIÇ Date: 2025-08-31 22:15:13 +0300 Hash: fd27e04cbfcd0a46cbababe042476a7f9ec7014f

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last Updated
0.7.0-preview035 14 8/31/2025
0.7.0-preview034 38 8/31/2025
0.7.0-preview033 154 8/28/2025
0.7.0-preview032 154 8/27/2025
0.7.0-preview031 145 8/10/2025
0.7.0-preview030 51 8/1/2025
0.7.0-preview029 62 8/1/2025
0.7.0-preview028 63 8/1/2025
0.7.0-preview027 100 7/31/2025
0.7.0-preview026 92 7/29/2025
0.7.0-preview025 68 7/27/2025
0.7.0-preview024 92 7/11/2025
0.7.0-preview023 94 7/11/2025
0.7.0-preview022 154 6/29/2025
0.7.0-preview021 167 6/23/2025
0.7.0-preview020 121 5/31/2025
0.7.0-preview019 173 3/23/2025
0.7.0-preview018 117 3/2/2025
0.7.0-preview017 114 2/23/2025
0.7.0-preview016 112 2/22/2025
0.7.0-preview015 100 2/21/2025
0.7.0-preview014 113 2/20/2025
0.7.0-preview013 111 2/9/2025
0.7.0-preview012 112 2/8/2025
0.7.0-preview011 117 2/2/2025
0.7.0-preview010 110 1/20/2025
0.7.0-preview009 106 1/19/2025
0.7.0-preview008 96 1/16/2025
0.7.0-preview007 112 12/29/2024
0.7.0-preview006 98 12/23/2024
0.7.0-preview005 102 11/27/2024
0.7.0-preview004 113 11/23/2024
0.7.0-preview003 123 11/20/2024
0.7.0-preview002 114 11/17/2024
0.7.0-preview001 125 11/14/2024
0.6.0 171 11/10/2024
0.6.0-preview002 128 11/10/2024
0.6.0-preview001 114 11/10/2024
0.5.1-preview002 118 9/30/2024
0.5.1-preview001 116 9/22/2024
0.5.0 168 8/30/2024
0.5.0-preview011 128 8/30/2024
0.5.0-preview010 159 8/25/2024
0.5.0-preview009 164 8/8/2024
0.5.0-preview008 147 8/7/2024
0.5.0-preview007 107 8/2/2024
0.5.0-preview006 111 7/30/2024
0.5.0-preview005 123 7/27/2024
0.5.0-preview004 140 7/15/2024
0.5.0-preview003 159 6/6/2024
0.5.0-preview002 148 6/5/2024
0.5.0-preview001 142 6/4/2024
0.4.0 146 5/19/2024
0.4.0-preview006 118 5/19/2024
0.4.0-preview005 147 5/12/2024
0.4.0-preview004 138 5/12/2024
0.4.0-preview003 140 5/11/2024
0.4.0-preview002 141 5/8/2024
0.4.0-preview001 150 5/5/2024
0.3.1-preview001 139 4/26/2024
0.3.0 159 4/23/2024
0.3.0-preview002 131 4/23/2024
0.3.0-preview001 159 4/23/2024
0.2.2-preview010 149 4/11/2024
0.2.2-preview009 143 3/18/2024
0.2.2-preview008 167 3/18/2024
0.2.2-preview007 152 3/16/2024
0.2.2-preview006 125 3/11/2024
0.2.2-preview005 129 3/10/2024
0.2.2-preview004 134 3/10/2024
0.2.2-preview003 156 1/22/2024
0.2.2-preview002 117 1/18/2024
0.2.2-preview001 146 1/14/2024
0.2.1 243 1/7/2024
0.2.0 190 12/31/2023
0.2.0-preview009 149 12/31/2023
0.2.0-preview008 170 12/30/2023
0.2.0-preview007 182 12/28/2023
0.2.0-preview006 167 12/27/2023
0.2.0-preview005 164 12/25/2023
0.2.0-preview004 169 12/23/2023
0.2.0-preview003 167 12/20/2023
0.2.0-preview002 164 12/19/2023
0.2.0-preview001 169 12/18/2023
0.1.0 243 11/26/2023
0.1.0-preview013 166 11/26/2023
0.1.0-preview012 184 11/20/2023
0.1.0-preview011 174 11/19/2023
0.1.0-preview010 219 10/30/2023
0.1.0-preview009 198 10/29/2023
0.1.0-preview008 200 10/27/2023
0.1.0-preview007 196 10/11/2023
0.1.0-preview006 201 10/9/2023
0.1.0-preview005 181 10/8/2023
0.1.0-preview004 209 10/8/2023
0.1.0-preview003 197 10/3/2023
0.1.0-preview002 203 10/3/2023
0.1.0-preview001 210 10/2/2023

Not every version includes changes, features or bug fixes. This project can increment version to keep consistency with other DRN.Framework projects.

## Version 0.5.0

My family celebrates the enduring legacy of Mustafa Kemal Atatürk's enlightenment ideals. This release is dedicated to August 30 Victory Day, a day that marks the decisive victory achieved by the Turkish people against imperialism during the Turkish War of Independence, leading to the establishment of the Republic of Türkiye.

### Breaking Changes

* DrnException implementations - refactored
 * Http status code parameter added
 * ExceptionFor factory class added to create DrnExceptions as needed

## Version 0.4.0

My family celebrates the enduring legacy of Mustafa Kemal Atatürk's enlightenment ideals. This release is dedicated to 19 May Commemoration of Atatürk, Youth and Sports Day.

## Version 0.3.0

My family celebrates the enduring legacy of Mustafa Kemal Atatürk's enlightenment ideals. This release is dedicated to 23 April National Sovereignty and Children's Day.

### Breaking Changes

* JsonSerializerOptions - moved to JsonConventions. System.Text.Json defaults will be overridden by JsonConventions when
 * TestContext is used in tests
 * DrnHostBuilder is used to build host

### New Features

* Entity and AggregateRoot base classes' ModifiedAt property now has `ConcurrencyCheck` attribute and can be used for optimistic concurrency.

### Bug Fixes

* `AppConstants` LocalIpAddress calculation exception handling

## Version 0.2.0

### New Features

* JsonSerializerOptions - added to AppConstants which is same with default dotnet settings for now.
* AggregateRoot, Entity, DomainEvent

## Version 0.1.0

### New Features

* AppConstants
* DRN Framework exceptions
 * ValidationException
 * NotFoundException
 * NotSavedException
 * ExpiredException
 * ConfigurationException

---

**Semper Progredi: Always Progressive**  
 
## Commit Info  
Author: Duran Serkan KILIÇ  
Date: 2024-09-22 21:27:25 +0300  
Hash: 5a1c8bb025cb41aef5138d4831359ed67c721257