MinimalRichDomain 0.2.0-alpha

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

MinimalRichDomain

A minimal impact shared kernel library for basic event-sourced domain models.

Usage

public partial class BlogPost : AggregateRoot<BlogPostId>
{
    public Title Title { get; private set; }
    public uint Views { get; private set; }

#pragma warning disable CS8618 // Rehydration ensures invariants are maintained.
    public BlogPost(BlogPostId id, IReadOnlyCollection<IDomainEvent> domainEvents) : base(id, domainEvents) { }
#pragma warning restore CS8618

    private BlogPost(BlogPostId key,
                     Title title,
                     uint views)
        : base(key)
    {
        Title = title;
        Views = views;
    }

    protected override void ValidateState()
    {
        if (Title is null)
            throw new InvalidOperationException("Blogger rehydrated in corrupt state. Title is missing.");
    }

    public static BlogPost New(Title title)
    {
        var blogPost = new BlogPost(BlogPostId.New(), title);
        blogPost.RaiseAndApplyDomainEvent(new NewBlogPostPostedEvent(blogPost.Id, blogPost.Title, 1));
        return blogPost;
    }

    public void View(BloggerId viewedBy)
    {
        RaiseAndApplyDomainEvent(new BlogPostViewedEvent(Id, viewedBy, DateTimeOffset.UtcNow, NextVersion));
    }
}

public partial class BlogPost : IApplyEvent<NewBlogPostPostedEvent>, IApplyEvent<BlogPostViewedEvent>
{
    void IApplyEvent<NewBlogPostPostedEvent>.Apply(NewBlogPostPostedEvent @event)
    {
        Title = @event.Title;
        Views = 0;
    }

    void IApplyEvent<BlogPostViewedEvent>.Apply(BlogPostViewedEvent @event)
    {
        Views++;
    }
}


public sealed record class NewBlogPostPostedEvent(BlogPostId Id, Title Title, int Version) : IDomainEvent;
public sealed record class BlogPostViewedEvent(BlogPostId BlogPostId, BloggerId ViewedBy, DateTimeOffset ViewedAt, int Version) : IDomainEvent;

MinimalRichDomain.SourceGenerators

Source generator for Id value objects for domain entities.

Usage

[GenerateId]
public class BlogPost
{
    public BlogPostId Id { get; } // Type generated by the source generator
}

Generated struct:

"using System;

#nullable enable
namespace SameNameSpaceAsEntityIdWasGeneratedFrom;

public readonly partial struct IdTypeName
{
    public Guid Value { get; }

    public static IdTypeName Empty => new(Guid.Empty);

    private IdTypeName(Guid value)
    {
        Value = value;
    }

    public static IdTypeName New() => new(Guid.NewGuid());

    public static IdTypeName FromValue(Guid value) => new(value);

    public static bool operator ==(IdTypeName left, IdTypeName right)
    {
        return left.Equals(right);
    }

    public static bool operator !=(IdTypeName left, IdTypeName right)
    {
        return !left.Equals(right);
    }

    public override bool Equals(object? obj)
    {
        if(obj is not IdTypeName other)
            return false;
        else
            return Value == other.Value;
    }

    public override int GetHashCode()
    {
        return Value.GetHashCode();
    }

    public override string? ToString()
    {
        return Value.ToString();
    }
}
#nullable restore
Product Compatible and additional computed target framework versions.
.NET net6.0 is compatible.  net6.0-android was computed.  net6.0-ios was computed.  net6.0-maccatalyst was computed.  net6.0-macos was computed.  net6.0-tvos was computed.  net6.0-windows was computed.  net7.0 was computed.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed.  net8.0 was computed.  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.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last Updated
1.1.3 139 7/6/2024
1.1.2 125 7/3/2024
1.1.1 136 7/3/2024
1.0.0 149 4/9/2024
0.2.0-alpha 123 4/9/2024
0.1.4-alpha 112 4/9/2024
0.1.3-alpha 226 12/10/2023
0.1.2-alpha 130 12/7/2023
0.1.1-alpha 110 12/6/2023
0.1.0-alpha 110 12/6/2023