Soenneker.Documents.Audit 4.0.2624

Prefix Reserved
dotnet add package Soenneker.Documents.Audit --version 4.0.2624
                    
NuGet\Install-Package Soenneker.Documents.Audit -Version 4.0.2624
                    
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="Soenneker.Documents.Audit" Version="4.0.2624" />
                    
For projects that support PackageReference, copy this XML node into the project file to reference the package.
<PackageVersion Include="Soenneker.Documents.Audit" Version="4.0.2624" />
                    
Directory.Packages.props
<PackageReference Include="Soenneker.Documents.Audit" />
                    
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 Soenneker.Documents.Audit --version 4.0.2624
                    
#r "nuget: Soenneker.Documents.Audit, 4.0.2624"
                    
#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 Soenneker.Documents.Audit@4.0.2624
                    
#: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=Soenneker.Documents.Audit&version=4.0.2624
                    
Install as a Cake Addin
#tool nuget:?package=Soenneker.Documents.Audit&version=4.0.2624
                    
Install as a Cake Tool

alternate text is missing from this package README image alternate text is missing from this package README image alternate text is missing from this package README image alternate text is missing from this package README image

Soenneker.Documents.Audit

Defines an audit-event document with entity, event, actor, and document metadata.

Installation

dotnet add package Soenneker.Documents.Audit

Usage

using Soenneker.Documents.Audit;
using Soenneker.Enums.CrudEventTypes;

string entityId = "customer-42";

var audit = new AuditDocument
{
    DocumentId = Guid.NewGuid().ToString("N"),
    PartitionKey = entityId,
    CreatedAt = DateTimeOffset.UtcNow,
    EntityId = entityId,
    EntityType = "Customer",
    EventType = CrudEventType.Update,
    UserId = currentUserId,
    Entity = new
    {
        Name = "Ada Lovelace",
        Status = "Active"
    }
};

DocumentId identifies the audit event. EntityId identifies the affected entity. Set PartitionKey to EntityId when using the package’s intended partitioning convention; the class does not assign or validate that relationship automatically.

Inherited document fields serialize as id, partitionKey, createdAt, and modifiedAt. Audit fields serialize as entity, entityId, entityType, eventType, and userId with System.Text.Json attributes.

Entity is typed as object so callers can store a snapshot or change payload. On deserialization, System.Text.Json normally materializes unknown object values as JsonElement. Use a known payload type or serializer-specific conversion when the snapshot must be read back as a concrete model.

EventType uses CrudEventType.Create, Read, Update, or Delete. The model does not generate IDs, timestamps, or actor information; populate those values before persistence.

Product Compatible and additional computed target framework versions.
.NET net10.0 is compatible.  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 (1)

Showing the top 1 NuGet packages that depend on Soenneker.Documents.Audit:

Package Downloads
Soenneker.Cosmos.Repository

A data persistence abstraction layer for Cosmos DB

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last Updated
4.0.2624 0 10/13/2026
4.0.2623 41 10/12/2026
4.0.2620 84 10/12/2026
4.0.2619 167 10/12/2026
4.0.2618 82 10/12/2026
4.0.2617 110 10/11/2026
4.0.2616 127 10/11/2026
4.0.2615 95 10/11/2026
4.0.2614 1,032 9/30/2026
4.0.2613 319 9/30/2026
4.0.2612 139 9/30/2026
4.0.2611 1,325 9/25/2026
4.0.2610 100 9/25/2026
4.0.2609 121 9/24/2026
4.0.2608 94 9/24/2026
4.0.2607 214 9/24/2026
4.0.2606 105 9/24/2026
4.0.2605 1,147 9/16/2026
4.0.2604 200 9/16/2026
4.0.2602 224 9/15/2026
Loading failed

Update dependency Soenneker.Documents.Document to 4.0.2741 (#3387)