DRN.Framework.SharedKernel 0.3.0-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.3.0-preview001
                    
NuGet\Install-Package DRN.Framework.SharedKernel -Version 0.3.0-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.3.0-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.3.0-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.3.0-preview001
                    
#r "nuget: DRN.Framework.SharedKernel, 0.3.0-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.3.0-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.3.0-preview001&prerelease
                    
Install as a Cake Addin
#tool nuget:?package=DRN.Framework.SharedKernel&version=0.3.0-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.

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);

AppConstants

namespace DRN.Framework.SharedKernel;

public static class AppConstants
{
    public static int ProcessId { get; } = Environment.ProcessId;
    public static Guid Id { get; } = Guid.NewGuid();
    public static string ApplicationName { 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();
...
}

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.Conventions;

public static class JsonConventions
{
...
    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 = new(JsonSerializerDefaults.Web)
    {
        Converters = { new JsonStringEnumConverter() },
        AllowTrailingCommas = true
    };
...
}

Exceptions

Following exceptions are used in DRN.Framework and DRN.Nexus and can be used any project. DRN exceptions contain additional category property so that same exception types can be differentiated with a subcategory.

namespace DRN.Framework.SharedKernel;

public abstract class DrnException(string message, Exception exception = null!, string? category = "default") : Exception(message, exception)
{
    public string Category { get; } = category ?? "default";
}

public class ValidationException(string message, Exception exception = null!, string? category = null) : DrnException(message, exception, category);

public class NotSavedException(string message, Exception exception = null!, string? category = null) : DrnException(message, exception, category);

public class NotFoundException(string message, Exception exception = null!, string? category = null) : DrnException(message, exception, category);

public class ExpiredException(string message, Exception exception = null!, string? category = null) : DrnException(message, exception, category);

public class ConfigurationException(string message, Exception exception = null!, string? category = null) : DrnException(message, exception, category);

Semper Progredi: Always Progressive

Commit Info

Author: Duran Serkan KILIÇ
Date: 2024-04-23 11:39:47 +0300
Hash: 7caeb49182fcf8619a92f95e015489522b3d3602

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-09-28 22:00:23 +0300 Hash: 9b97bc89d55446d234e3a91d045c2e8094fd1733

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last Updated
0.7.0-preview037 0 9/28/2025
0.7.0-preview036 135 9/22/2025
0.7.0-preview035 182 8/31/2025
0.7.0-preview034 195 8/31/2025
0.7.0-preview033 220 8/28/2025
0.7.0-preview032 215 8/27/2025
0.7.0-preview031 184 8/10/2025
0.7.0-preview030 76 8/1/2025
0.7.0-preview029 74 8/1/2025
0.7.0-preview028 82 8/1/2025
0.7.0-preview027 125 7/31/2025
0.7.0-preview026 112 7/29/2025
0.7.0-preview025 124 7/27/2025
0.7.0-preview024 117 7/11/2025
0.7.0-preview023 121 7/11/2025
0.7.0-preview022 182 6/29/2025
0.7.0-preview021 186 6/23/2025
0.7.0-preview020 143 5/31/2025
0.7.0-preview019 190 3/23/2025
0.7.0-preview018 133 3/2/2025
0.7.0-preview017 123 2/23/2025
0.7.0-preview016 118 2/22/2025
0.7.0-preview015 117 2/21/2025
0.7.0-preview014 118 2/20/2025
0.7.0-preview013 127 2/9/2025
0.7.0-preview012 131 2/8/2025
0.7.0-preview011 133 2/2/2025
0.7.0-preview010 126 1/20/2025
0.7.0-preview009 115 1/19/2025
0.7.0-preview008 113 1/16/2025
0.7.0-preview007 130 12/29/2024
0.7.0-preview006 114 12/23/2024
0.7.0-preview005 121 11/27/2024
0.7.0-preview004 126 11/23/2024
0.7.0-preview003 151 11/20/2024
0.7.0-preview002 136 11/17/2024
0.7.0-preview001 150 11/14/2024
0.6.0 202 11/10/2024
0.6.0-preview002 146 11/10/2024
0.6.0-preview001 134 11/10/2024
0.5.1-preview002 140 9/30/2024
0.5.1-preview001 138 9/22/2024
0.5.0 194 8/30/2024
0.5.0-preview011 155 8/30/2024
0.5.0-preview010 184 8/25/2024
0.5.0-preview009 190 8/8/2024
0.5.0-preview008 173 8/7/2024
0.5.0-preview007 129 8/2/2024
0.5.0-preview006 141 7/30/2024
0.5.0-preview005 159 7/27/2024
0.5.0-preview004 163 7/15/2024
0.5.0-preview003 183 6/6/2024
0.5.0-preview002 174 6/5/2024
0.5.0-preview001 164 6/4/2024
0.4.0 170 5/19/2024
0.4.0-preview006 144 5/19/2024
0.4.0-preview005 165 5/12/2024
0.4.0-preview004 164 5/12/2024
0.4.0-preview003 166 5/11/2024
0.4.0-preview002 169 5/8/2024
0.4.0-preview001 173 5/5/2024
0.3.1-preview001 161 4/26/2024
0.3.0 188 4/23/2024
0.3.0-preview002 167 4/23/2024
0.3.0-preview001 184 4/23/2024
0.2.2-preview010 176 4/11/2024
0.2.2-preview009 169 3/18/2024
0.2.2-preview008 193 3/18/2024
0.2.2-preview007 168 3/16/2024
0.2.2-preview006 150 3/11/2024
0.2.2-preview005 148 3/10/2024
0.2.2-preview004 155 3/10/2024
0.2.2-preview003 186 1/22/2024
0.2.2-preview002 137 1/18/2024
0.2.2-preview001 166 1/14/2024
0.2.1 263 1/7/2024
0.2.0 208 12/31/2023
0.2.0-preview009 163 12/31/2023
0.2.0-preview008 189 12/30/2023
0.2.0-preview007 199 12/28/2023
0.2.0-preview006 183 12/27/2023
0.2.0-preview005 183 12/25/2023
0.2.0-preview004 183 12/23/2023
0.2.0-preview003 175 12/20/2023
0.2.0-preview002 183 12/19/2023
0.2.0-preview001 190 12/18/2023
0.1.0 261 11/26/2023
0.1.0-preview013 186 11/26/2023
0.1.0-preview012 202 11/20/2023
0.1.0-preview011 184 11/19/2023
0.1.0-preview010 242 10/30/2023
0.1.0-preview009 217 10/29/2023
0.1.0-preview008 220 10/27/2023
0.1.0-preview007 211 10/11/2023
0.1.0-preview006 221 10/9/2023
0.1.0-preview005 201 10/8/2023
0.1.0-preview004 223 10/8/2023
0.1.0-preview003 217 10/3/2023
0.1.0-preview002 224 10/3/2023
0.1.0-preview001 227 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.3.0

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

Semper Progredi: Always Progressive

### 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

## Version 0.2.0

### New Features

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

## Version 0.1.0

### Breaking Changes

### New Features

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

### Bug Fixes  
 
## Commit Info  
Author: Duran Serkan KILIÇ  
Date: 2024-04-23 11:39:47 +0300  
Hash: 7caeb49182fcf8619a92f95e015489522b3d3602