Dolittle.SDK.Failures 23.5.0

There is a newer version of this package available.
See the version list below for details.
dotnet add package Dolittle.SDK.Failures --version 23.5.0                
NuGet\Install-Package Dolittle.SDK.Failures -Version 23.5.0                
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="Dolittle.SDK.Failures" Version="23.5.0" />                
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add Dolittle.SDK.Failures --version 23.5.0                
#r "nuget: Dolittle.SDK.Failures, 23.5.0"                
#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.
// Install Dolittle.SDK.Failures as a Cake Addin
#addin nuget:?package=Dolittle.SDK.Failures&version=23.5.0

// Install Dolittle.SDK.Failures as a Cake Tool
#tool nuget:?package=Dolittle.SDK.Failures&version=23.5.0                

Dolittle

Dolittle is a decentralized, distributed, event-driven microservice platform built to harness the power of events.

This is our C# SDK, install it with:

dotnet add package Dolittle.SDK 

Get Started

Want to try another language?

Issues and Contributing

Issues and contributions are always welcome!

To learn how to contribute, please read our contributing guide.

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 is compatible.  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 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. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages (3)

Showing the top 3 NuGet packages that depend on Dolittle.SDK.Failures:

Package Downloads
Dolittle.SDK.Events

Dolittle is a decentralized, distributed, event-driven microservice platform built to harness the power of events.

Dolittle.SDK

Dolittle is a decentralized, distributed, event-driven microservice platform built to harness the power of events.

Dolittle.SDK.Tenancy.Client

Dolittle is a decentralized, distributed, event-driven microservice platform built to harness the power of events.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
24.0.0 168 11/13/2024
23.5.2 256 11/13/2024
23.5.1 217 11/7/2024
23.5.0 670 10/23/2024
23.4.0 466 10/2/2024
23.3.0 597 7/31/2024
23.2.5 709 6/20/2024
23.2.4 363 6/13/2024
23.2.3 298 6/10/2024
23.2.2 296 6/2/2024
23.2.1 292 5/16/2024
23.2.0 1,746 3/14/2024
23.1.0 379 3/12/2024
23.0.0 359 3/8/2024
22.1.3 471 2/26/2024
22.1.2 1,391 10/24/2023
22.1.1 607 10/4/2023
22.1.0 533 9/18/2023
22.0.5 583 9/7/2023
22.0.4 634 8/28/2023
22.0.3 697 8/15/2023
22.0.2 673 8/8/2023
22.0.1 599 8/8/2023
22.0.0 885 6/22/2023
22.0.0-arkenstone.1 86 6/21/2023
22.0.0-arkenstone.0 86 6/12/2023
21.0.2 742 9/7/2023
21.0.1 2,716 6/8/2023
21.0.0 729 6/2/2023
21.0.0-feanor.2 83 5/31/2023
21.0.0-feanor.1 1,141 5/30/2023
21.0.0-feanor.0 85 5/30/2023
20.2.0 3,404 1/23/2023
20.2.0-shire.17 115 1/19/2023
20.2.0-shire.16 106 1/16/2023
20.2.0-shire.15 112 1/12/2023
20.2.0-shire.14 112 1/12/2023
20.2.0-shire.13 103 1/12/2023
20.2.0-shire.12 143 1/11/2023
20.2.0-shire.11 109 1/10/2023
20.2.0-shire.10 109 1/6/2023
20.2.0-shire.9 187 1/6/2023
20.2.0-shire.8 109 1/6/2023
20.2.0-shire.7 113 1/6/2023
20.2.0-shire.6 122 1/5/2023
20.2.0-shire.5 115 1/5/2023
20.2.0-shire.4 114 1/5/2023
20.2.0-shire.3 119 1/5/2023
20.2.0-shire.2 117 12/26/2022
20.2.0-shire.1 122 12/26/2022
20.2.0-shire.0 113 12/26/2022
20.1.0 1,336 12/25/2022
20.1.0-faramir.1 102 12/12/2022
20.1.0-faramir.0 101 12/9/2022
20.0.2 2,083 12/13/2022
20.0.1 1,379 12/12/2022
20.0.0 1,390 12/8/2022
19.1.0-elrond.7 107 12/7/2022
19.1.0-elrond.6 101 12/5/2022
19.1.0-elrond.5 98 12/5/2022
19.1.0-elrond.4 105 12/2/2022
19.1.0-elrond.3 100 12/2/2022
19.1.0-elrond.2 102 11/29/2022
19.1.0-elrond.1 100 11/28/2022
19.1.0-elrond.0 101 11/28/2022
19.0.0 2,444 11/25/2022
19.0.0-proto.5 94 11/25/2022
19.0.0-proto.4 121 11/22/2022
19.0.0-proto.3 103 11/21/2022
19.0.0-proto.2 101 11/21/2022
19.0.0-proto.1 103 11/21/2022
19.0.0-proto.0 104 11/18/2022
18.2.0-bolt.1 97 11/16/2022
18.2.0-bolt.0 112 11/16/2022
18.1.1 3,205 10/31/2022
18.1.0 3,219 10/26/2022
18.0.1 3,310 10/20/2022
18.0.0 3,496 9/15/2022
17.2.3 3,549 9/9/2022
17.2.2 4,130 8/26/2022
17.2.1 4,330 8/10/2022
17.2.0 3,645 7/8/2022
17.1.2 3,534 7/7/2022
17.1.1 3,487 7/7/2022
17.1.0 3,475 7/5/2022
17.1.0-boromir.4 127 7/8/2022
17.1.0-boromir.3 119 7/5/2022
17.1.0-boromir.2 117 7/1/2022
17.1.0-boromir.1 114 7/1/2022
17.0.2 4,024 6/21/2022
17.0.0 6,745 3/25/2022
17.0.0-meriadoc.0 134 3/24/2022
16.0.1 3,676 3/22/2022
16.0.0 3,655 3/14/2022
15.1.3 3,658 3/8/2022
15.1.2 3,702 3/1/2022
15.1.1 3,695 2/11/2022
15.1.0 3,651 2/11/2022
15.0.1 3,798 2/10/2022
15.0.0 3,586 2/10/2022
14.2.0 3,656 2/9/2022
14.2.0-sam.2 124 2/9/2022
14.2.0-sam.1 126 2/7/2022
14.2.0-sam.0 121 2/7/2022
14.1.0 3,713 1/28/2022
14.0.0 3,718 1/25/2022
14.0.0-gollum.1 137 1/25/2022
14.0.0-gollum.0 126 1/24/2022
13.1.0-bilbo.4 134 1/24/2022
13.1.0-bilbo.3 131 1/24/2022
13.1.0-bilbo.2 124 1/21/2022
13.1.0-bilbo.1 132 1/21/2022
13.1.0-bilbo.0 141 1/21/2022
13.0.1 3,636 1/24/2022
13.0.0 3,705 1/20/2022
13.0.0-gimli.10 150 1/20/2022
13.0.0-gimli.9 177 1/19/2022
13.0.0-gimli.8 125 1/19/2022
13.0.0-gimli.7 129 1/18/2022
13.0.0-gimli.6 135 1/17/2022
13.0.0-gimli.5 142 1/17/2022
13.0.0-gimli.4 142 1/17/2022
13.0.0-gimli.3 158 12/7/2021
13.0.0-gimli.2 175 12/7/2021
13.0.0-gimli.1 174 12/7/2021
13.0.0-gimli.0 866 12/1/2021
12.1.0-gandalf.0 1,448 11/26/2021
12.0.0 2,518 11/18/2021
12.0.0-legolas.7 138 11/18/2021
12.0.0-legolas.6 155 11/16/2021
12.0.0-legolas.5 141 11/15/2021
12.0.0-legolas.4 154 11/15/2021
12.0.0-legolas.3 176 11/11/2021
12.0.0-legolas.2 158 11/10/2021
12.0.0-legolas.1 157 11/9/2021
12.0.0-legolas.0 151 11/9/2021
11.0.0 8,934 11/5/2021
11.0.0-aragorn.8 175 11/5/2021
11.0.0-aragorn.7 177 11/4/2021
11.0.0-aragorn.6 151 11/4/2021
11.0.0-aragorn.5 169 11/4/2021
11.0.0-aragorn.4 174 11/2/2021
11.0.0-aragorn.3 176 11/2/2021
11.0.0-aragorn.2 163 10/29/2021
11.0.0-aragorn.1 145 10/26/2021
11.0.0-aragorn.0 199 10/25/2021
10.1.0 2,758 10/21/2021
10.0.0 2,492 10/13/2021
10.0.0-eventsource.1 158 10/13/2021
10.0.0-eventsource.0 143 10/5/2021
9.2.0 8,056 9/29/2021
9.2.0-register-all.1 157 9/15/2021
9.2.0-register-all.0 151 9/7/2021
9.1.1 3,552 12/21/2021
9.1.0 6,671 7/14/2021
9.1.0-embeddings.0 149 7/5/2021
9.0.0 2,604 6/16/2021
8.5.0-timeout.4 1,370 6/4/2021
8.5.0-timeout.3 162 6/4/2021
8.5.0-timeout.2 218 5/31/2021
8.5.0-timeout.1 323 5/30/2021
8.5.0-timeout.0 243 5/29/2021
8.4.0 9,405 4/9/2021
8.4.0-projections.2 172 4/9/2021
8.4.0-projections.1 172 4/7/2021
8.4.0-projections.0 173 4/7/2021
8.3.2 3,828 3/24/2021
8.3.1 2,461 2/22/2021
8.3.0 2,300 2/17/2021
8.2.0 2,313 2/17/2021
8.1.1 2,280 2/14/2021
8.1.0 2,309 2/14/2021
8.1.0-updatedeps.0 204 1/20/2021
8.0.0 4,254 11/2/2020
7.0.0-redpill.1 299 10/14/2020
7.0.0-redpill.0 340 10/13/2020

Version 23.5.0:
This adds support for retroactively redacting personal data details from previously committed events. Redactions are scoped to a single EventSourceId, and a single event type, and allow you to overwrite or remove specific fields.

How to use it:
Events that should be redacted must be annotated to target the fields that should be updated or removed

[EventType("24e3a119-57d5-45d7-b7ef-a736fe6331e7")]
public class CustomerRegistered
{
   // The generic type will replace the value
   [RedactablePersonalData<string>("<redacted>")]
   public string Name { get; init; }
   
   //  The non-generic one will remove the field altogether
   [RedactablePersonalData]
   public Address? CustomerAddress { get; init; }
}They can then be redacted by committing a targeted redaction event on the same eventsourceId as the redacted events.

It can either be done with the built-in event

   public void GdprForget(string reason, string performedBy)
   {
       Apply(Redactions.Create<CustomerRegistered>(reason, performedBy));
   }or a user-created event

[EventType("de1e7e17-bad5-da7a-a4f7-e409ae1785dc")]
public class CustomerDetailsForgotten : PersonalDataRedactedForEvent<CustomerRegistered>
{
}Applied like this

   public void GdprForget(string reason, string performedBy)
   {
       Apply(Redactions.Create<CustomerRegistered, CustomerDetailsForgotten>(reason, performedBy));
   }What about read models and aggregate state ?:
Aggregates and read models should handle the redactions as normal events, and update state accordingly.

Ex

   public void On(CustomerDetailsForgotten evt)
   {
       _address = null;
       _name = null;
       _gdprRedacted = true;
   }Read models are not automagically updated, but should handle the redaction events themselves. Redaction events after being committed behave exactly as any other event, and can be processed by both eventhandlers and projections.

Since you would want the eventhandlers to only handle as few events as needed, user defined redaction events are the suggested way to perform redactions.

How does it work?:
The runtime will recognize the redaction event type with the redaction prefix "de1e7e17-bad5-da7a", and if the events have the correctly formatted structure, it will perform the redactions in the same transaction as the new events are being added.

It will replace overridden properties as specified in RedactedProperties, and remove properties that are defined with null values.

Redaction events themselves cannot be redacted, to ensure auditability of the system.

Added:
- Dolittle.SDK.Events.Redaction.PersonalDataRedactedForEvent - Built in event that can redact any event type
- Dolittle.SDK.Events.Redaction.PersonalDataRedactedForEvent<TEvent> - Class to extend in order to create redactions for specific events
- Dolittle.SDK.Events.Redaction - Use this to simplify creation of redaction events

Updated:
- The solution was updated to use centralized package management (https://learn.microsoft.com/en-us/nuget/consume-packages/Central-Package-Management) to simplify dependency maintenance. Dependencies have also been upgraded.

Changelog:
For all release notes, see changelog (https://github.com/dolittle/DotNET.SDK/blob/master/CHANGELOG.md)