ktsu.Essentials 2.0.0

Prefix Reserved

dotnet add package ktsu.Essentials --version 2.0.0

NuGet\Install-Package ktsu.Essentials -Version 2.0.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="ktsu.Essentials" Version="2.0.0" />

For projects that support PackageReference, copy this XML node into the project file to reference the package.

<PackageVersion Include="ktsu.Essentials" Version="2.0.0" />
                    

                            Directory.Packages.props

<PackageReference Include="ktsu.Essentials" />
                    

                            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 ktsu.Essentials --version 2.0.0

The NuGet Team does not provide support for this client. Please contact its maintainers for support.

#r "nuget: ktsu.Essentials, 2.0.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.

#:package ktsu.Essentials@2.0.0

#: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=ktsu.Essentials&version=2.0.0
                    

                            Install as a Cake Addin

#tool nuget:?package=ktsu.Essentials&version=2.0.0
                    

                            Install as a Cake Tool

The NuGet Team does not provide support for this client. Please contact its maintainers for support.

ktsu.Essentials

A comprehensive .NET library providing high-performance interfaces and implementations for common cross-cutting concerns including compression, encoding, obfuscation, encryption, hashing, serialization, caching, persistence, validation, logging, navigation, command execution, and filesystem access.

Introduction

ktsu.Essentials defines a consistent, high-performance API for common cross-cutting concerns in .NET applications. Each provider interface follows a three-tier pattern: core Try* methods over Span<byte> and Stream that report how many bytes they wrote, convenient self-allocating methods, and async variants with CancellationToken support. Implementers only need to provide the core Try* methods — all convenience and async methods are provided via default interface implementations. The ktsu.Essentials package is interfaces only; implementations ship as separate ktsu.Essentials.<Category>.<Impl> packages, with ktsu.Essentials.All bundling every one of them. Higher-level concerns are expressed by composition rather than duplication — configuration is simply an IPersistenceProvider<TKey> over a serializer, and obfuscation composes encoding transforms.

Features

Compression: ICompressionProvider with Gzip, Brotli, Deflate, and ZLib implementations
Encoding: IEncodingProvider with Base64 and Hex implementations for format/transport encoding
Obfuscation: IObfuscationProvider with XOR, Caesar, bit-rotation, byte-reversal, Base64, and Hex implementations, plus a Composite provider that pipelines several together. Obfuscation is reversible but is not encryption — it provides no confidentiality
Dependency Injection: every provider package ships an Add<Impl><Category>Provider() extension; ktsu.Essentials.All adds per-category helpers and a single AddEssentials(). Registrations are idempotent and expose each provider by both concrete type and interface
Encryption: IEncryptionProvider with AES implementation including key and IV generation
Hashing: IHashProvider with 15 implementations (MD5, SHA1/256/384/512, FNV1/FNV1a 32/64-bit, CRC32/64, XxHash32/64/3/128)
Serialization: ISerializationProvider with System.Text.Json, Newtonsoft.Json, YAML, and TOML implementations plus configurable ISerializationOptions
Caching: ICacheProvider<TKey, TValue> with in-memory implementation supporting expiration and get-or-add semantics
Persistence: IPersistenceProvider<TKey> with DataHome, ConfigHome, FileSystem, InMemory, and Temp implementations. DataHome and ConfigHome follow the XDG Base Directory layout on every platform — $XDG_DATA_HOME or ~/.local/share/<app> for application state, $XDG_CONFIG_HOME or ~/.config/<app> for user settings — with ~ resolving to %USERPROFILE% on Windows
Validation: IValidationProvider<T> with structured results, error codes, and throw-on-failure support
Logging: ILoggingProvider with console implementation supporting six severity levels
Navigation: INavigationProvider<T> with in-memory implementation for browser-like back/forward navigation
Command Execution: ICommandExecutor with native implementation for running shell commands and capturing output
Filesystem: IFileSystemProvider extending Testably.Abstractions for testable filesystem access
Explicit Buffer Contract: every span operation is bool TryX(source, destination, out int bytesWritten) and each category exposes a GetMax…Length bound, so callers can size a buffer up front and know exactly how much was written. Encoding, hashing and obfuscation run allocation-free on the span path; compression and encryption still buffer internally, because the underlying BCL APIs for those are stream-only
Minimal Implementation Burden: Default interface implementations reduce boilerplate — implement only the core Try* methods
Comprehensive Async Support: Every operation has async variants with proper CancellationToken support
Batteries-Included or Cherry-Pick: Each provider ships as its own ktsu.Essentials.<Category>.<Impl> package; install the ktsu.Essentials.All meta-package to get every provider at once, or reference only the ones you need

Installation

Package Manager Console

Install-Package ktsu.Essentials

.NET CLI

dotnet add package ktsu.Essentials

Package Reference

<PackageReference Include="ktsu.Essentials" Version="x.y.z" />

Usage Examples

Basic Example

using ktsu.Essentials;
using ktsu.Essentials.All;
using ktsu.Essentials.HashProviders.SHA256;
using Microsoft.Extensions.DependencyInjection;

// Each provider package ships its own registration extension
IServiceCollection services = new ServiceCollection();
services.AddSHA256HashProvider();
services.AddGzipCompressionProvider();
services.AddBase64EncodingProvider();

// ...or register everything at once with the ktsu.Essentials.All package
services.AddEssentials();

using ServiceProvider provider = services.BuildServiceProvider();

// Resolve a specific implementation by its concrete type...
SHA256HashProvider sha256 = provider.GetRequiredService<SHA256HashProvider>();

// ...or every registered implementation of an interface
IEnumerable<IHashProvider> allHashProviders = provider.GetServices<IHashProvider>();

IHashProvider hashProvider = sha256;

// Convenience method (auto-allocates buffer)
byte[] hash = hashProvider.Hash("Hello, World!");

// Buffer-based method — no allocation, and it tells you how much it wrote
Span<byte> buffer = stackalloc byte[hashProvider.HashLengthBytes];
if (hashProvider.TryHash("Hello, World!"u8, buffer, out int written))
{
    string hex = Convert.ToHexString(buffer[..written]);
}

// Async method
byte[] asyncHash = await hashProvider.HashAsync("Hello, World!");

Compression

ICompressionProvider compressor = provider.GetRequiredService<ICompressionProvider>();

byte[] compressed = compressor.Compress(originalData);
byte[] decompressed = compressor.Decompress(compressed);

// String convenience — compressed bytes are returned as Base64 so they survive as text
string compressedText = compressor.Compress("Large text content...");
string originalText = compressor.Decompress(compressedText);

Serialization

ISerializationProvider serializer = provider.GetRequiredService<ISerializationProvider>();

string json = serializer.Serialize(myObject);
MyClass? deserialized = serializer.Deserialize<MyClass>(json);

// Async
string asyncJson = await serializer.SerializeAsync(myObject);

Caching

ICacheProvider<string, MyData> cache = provider.GetRequiredService<ICacheProvider<string, MyData>>();

cache.Set("key", myData, expiration: TimeSpan.FromMinutes(5));
MyData value = cache.GetOrAdd("key", k => LoadData(k));

Persistence

IPersistenceProvider<string> persistence = provider.GetRequiredService<IPersistenceProvider<string>>();

await persistence.StoreAsync("settings", mySettings);
MySettings? loaded = await persistence.RetrieveAsync<MySettings>("settings");
MySettings guaranteed = await persistence.RetrieveOrCreateAsync<MySettings>("settings");

The DataHome and ConfigHome providers need an application name, so register them explicitly rather than through AddEssentials():

using ktsu.Essentials.PersistenceProviders.ConfigHome;
using ktsu.Essentials.PersistenceProviders.DataHome;

// User settings   -> $XDG_CONFIG_HOME/MyApp   or ~/.config/MyApp
services.AddConfigHomePersistenceProvider<string>("MyApp");

// Application state -> $XDG_DATA_HOME/MyApp   or ~/.local/share/MyApp
services.AddDataHomePersistenceProvider<string>("MyApp");

Both use the same layout on every platform, with ~ resolving to %USERPROFILE% on Windows. If you need the paths without a persistence provider, UserDirectories exposes them directly:

string dataDir = UserDirectories.GetApplicationDataDirectory("MyApp");
string configDir = UserDirectories.GetApplicationConfigDirectory("MyApp");

Implementing a Custom Provider

Implementers only need to provide the core Try* methods — all other methods are inherited:

using ktsu.Essentials;

public sealed class MyHashProvider : IHashProvider
{
    public int HashLengthBytes => 32;

    public bool TryHash(ReadOnlySpan<byte> data, Span<byte> destination, out int bytesWritten)
    {
        bytesWritten = 0;
        if (destination.Length < HashLengthBytes) return false;
        // Custom hash logic here
        bytesWritten = HashLengthBytes;
        return true;
    }

    public bool TryHash(Stream data, Span<byte> destination, out int bytesWritten)
    {
        bytesWritten = 0;
        if (destination.Length < HashLengthBytes) return false;
        // Custom stream hash logic here
        bytesWritten = HashLengthBytes;
        return true;
    }

    // Hash(), HashAsync(), string overloads — all inherited
}

API Reference

`ICompressionProvider`

Compress and decompress data with Span, Stream, and string support.

Name	Return Type	Description
`GetMaxCompressedLength(int)`	`int`	Buffer size that always fits the output
`TryCompress(ReadOnlySpan<byte>, Span<byte>, out int)`	`bool`	Compress, reporting bytes written
`TryCompress(Stream, Stream)`	`bool`	Stream-based compression
`Compress(ReadOnlySpan<byte>)`	`byte[]`	Self-allocating compression
`Compress(string)`	`string`	Compresses UTF8 text, returns Base64
`TryDecompress(ReadOnlySpan<byte>, Span<byte>, out int)`	`bool`	Decompress, reporting bytes written
`Decompress(ReadOnlySpan<byte>)`	`byte[]`	Self-allocating decompression
`Decompress(string)`	`string`	Reverses `Compress(string)`

`IEncodingProvider`

Format/transport encoding (Base64, Hex) — not text character encodings.

Name	Return Type	Description
`GetMaxEncodedLength(int)` / `GetMaxDecodedLength(int)`	`int`	Buffer sizes that always fit the output
`TryEncode(ReadOnlySpan<byte>, Span<byte>, out int)`	`bool`	Encode, reporting bytes written
`TryEncode(Stream, Stream)`	`bool`	Stream-based encoding
`Encode(ReadOnlySpan<byte>)`	`byte[]`	Self-allocating encoding
`Encode(string)`	`string`	Encodes UTF8 text
`TryDecode(ReadOnlySpan<byte>, Span<byte>, out int)`	`bool`	Decode, reporting bytes written
`Decode(ReadOnlySpan<byte>)`	`byte[]`	Self-allocating decoding
`Decode(string)`	`string`	Reverses `Encode(string)`

`IEncryptionProvider`

Encrypt and decrypt data with key and IV management.

Name	Return Type	Description
`GetMaxEncryptedLength(int)`	`int`	Buffer size that always fits the ciphertext
`TryEncrypt(ReadOnlySpan<byte>, …, Span<byte>, out int)`	`bool`	Encrypt, reporting bytes written
`TryDecrypt(ReadOnlySpan<byte>, …, Span<byte>, out int)`	`bool`	Decrypt, reporting bytes written
`Encrypt(string, ...)`	`string`	Encrypts UTF8 text, returns Base64
`Decrypt(string, ...)`	`string`	Reverses `Encrypt(string, ...)`
`GenerateKey()`	`byte[]`	Generates a new encryption key
`GenerateIV()`	`byte[]`	Generates a new initialization vector

`IHashProvider`

Hash data with configurable output length. Exposes HashLengthBytes property for the output size in bytes.

Name	Return Type	Description
`TryHash(ReadOnlySpan<byte>, Span<byte>, out int)`	`bool`	Hash, reporting bytes written
`TryHash(Stream, Span<byte>, out int)`	`bool`	Stream-based hashing
`Hash(ReadOnlySpan<byte>)`	`byte[]`	Self-allocating hashing
`Hash(string)`	`byte[]`	Hash a UTF8 string

`ISerializationProvider`

Serialize and deserialize objects supporting JSON, YAML, TOML, and other text-based formats.

Name	Return Type	Description
`FileExtension`	`string`	Conventional extension for the format, e.g. `.yaml`
`TrySerialize(object, TextWriter)`	`bool`	Serialize to a TextWriter
`Serialize(object)`	`string`	Serialize to a string
`Deserialize<T>(ReadOnlySpan<byte>)`	`T?`	Deserialize from bytes
`Deserialize<T>(string)`	`T?`	Deserialize from a string
`Deserialize<T>(TextReader)`	`T?`	Deserialize from a TextReader

`ICacheProvider<TKey, TValue>`

Cache key-value pairs with optional expiration.

Name	Return Type	Description
`TryGet(TKey, out TValue?)`	`bool`	Try to get a cached value
`Get(TKey)`	`TValue`	Get a value or throw
`Set(TKey, TValue, TimeSpan?)`	`void`	Set a value with optional expiration
`GetOrAdd(TKey, Func<TKey, TValue>, TimeSpan?)`	`TValue`	Get or create a value
`Remove(TKey)`	`bool`	Remove a cached value
`Clear()`	`void`	Clear all entries

`IPersistenceProvider<TKey>`

Store and retrieve objects with pluggable storage backends. Exposes ProviderName and IsPersistent properties.

Name	Return Type	Description
`StoreAsync<T>(TKey, T)`	`Task`	Store an object
`RetrieveAsync<T>(TKey)`	`Task<T?>`	Retrieve an object
`RetrieveOrCreateAsync<T>(TKey)`	`Task<T>`	Retrieve or create a new instance
`ExistsAsync(TKey)`	`Task<bool>`	Check if a key exists
`RemoveAsync(TKey)`	`Task<bool>`	Remove an object
`GetAllKeysAsync()`	`Task<IEnumerable<TKey>>`	List all stored keys
`ClearAsync()`	`Task`	Clear all stored objects

`IValidationProvider<T>`

Validate objects and return structured results.

Name	Return Type	Description
`Validate(T)`	`ValidationResult`	Validate and return result
`IsValid(T)`	`bool`	Check validity
`ValidateAndThrow(T)`	`void`	Validate or throw `ValidationException`

`ILoggingProvider`

Write structured log messages at various severity levels.

Name	Return Type	Description
`Log(LogLevel, string)`	`void`	Write a log entry
`Log(LogLevel, Exception, string)`	`void`	Write a log entry with an exception
`IsEnabled(LogLevel)`	`bool`	Check if a log level is enabled
`LogTrace(string)` through `LogCritical(string)`	`void`	Level-specific convenience methods

`INavigationProvider<T>`

Browser-like back/forward navigation. Exposes Current, CanGoBack, and CanGoForward properties.

Name	Return Type	Description
`NavigateTo(T)`	`void`	Navigate to a destination
`GoBack()`	`T?`	Navigate backward
`GoForward()`	`T?`	Navigate forward
`Clear()`	`void`	Clear all history

`ICommandExecutor`

Run shell commands and capture output.

Name	Return Type	Description
`ExecuteAsync(string, string?)`	`Task<CommandResult>`	Execute a command
`Execute(string, string?)`	`CommandResult`	Execute a command synchronously
`ExecuteAndGetOutputAsync(string, string?)`	`Task<string>`	Execute and return stdout or throw

`IFileSystemProvider`

Extends Testably.Abstractions.IFileSystem for testable filesystem operations.

Contributing

Contributions are welcome! Feel free to open issues or submit pull requests.

License

This project is licensed under the MIT License. See the LICENSE.md file for details.

Product	Compatible and additional computed target framework versions.
.NET	net5.0 was computed. net5.0-windows was computed. 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. net9.0 is compatible. 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 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.
.NET Core	netcoreapp3.0 was computed. netcoreapp3.1 was computed.
.NET Standard	netstandard2.1 is compatible.
MonoAndroid	monoandroid was computed.
MonoMac	monomac was computed.
MonoTouch	monotouch was computed.
Tizen	tizen60 was computed.
Xamarin.iOS	xamarinios was computed.
Xamarin.Mac	xamarinmac was computed.
Xamarin.TVOS	xamarintvos was computed.
Xamarin.WatchOS	xamarinwatchos was computed.

Compatible target framework(s)

Included target framework(s) (in package)

Learn more about Target Frameworks and .NET Standard.

.NETStandard 2.1
- Testably.Abstractions (>= 10.0.0)
- Testably.Abstractions.FileSystem.Interface (>= 10.0.0)
net10.0
- Testably.Abstractions (>= 10.0.0)
- Testably.Abstractions.FileSystem.Interface (>= 10.0.0)
net6.0
- Testably.Abstractions (>= 10.0.0)
- Testably.Abstractions.FileSystem.Interface (>= 10.0.0)
net7.0
- Testably.Abstractions (>= 10.0.0)
- Testably.Abstractions.FileSystem.Interface (>= 10.0.0)
net8.0
- Testably.Abstractions (>= 10.0.0)
- Testably.Abstractions.FileSystem.Interface (>= 10.0.0)
net9.0
- Testably.Abstractions (>= 10.0.0)
- Testably.Abstractions.FileSystem.Interface (>= 10.0.0)

NuGet packages (78)

Showing the top 5 NuGet packages that depend on ktsu.Essentials:

Package	Downloads
ktsu.HashProviders.FNV1a_32 A comprehensive .NET library providing high-performance interfaces and ready-to-use implementations for common cross-cutting concerns including compression (Gzip, Brotli, Deflate, ZLib), encoding (Base64, Hex), encryption (AES), hashing (15 algorithms including SHA, MD5, CRC, FNV, XxHash), serialization (JSON, YAML, TOML), caching, persistence, validation, logging, navigation, command execution, and filesystem access. Features zero-allocation Span-based operations, default interface implementations to minimize boilerplate, and comprehensive async support with CancellationToken.	19.6K
ktsu.CompressionProviders.Gzip A comprehensive .NET library providing high-performance interfaces and ready-to-use implementations for common cross-cutting concerns including compression (Gzip, Brotli, Deflate, ZLib), encoding (Base64, Hex), encryption (AES), hashing (15 algorithms including SHA, MD5, CRC, FNV, XxHash), serialization (JSON, YAML, TOML), caching, persistence, validation, logging, navigation, command execution, and filesystem access. Features zero-allocation Span-based operations, default interface implementations to minimize boilerplate, and comprehensive async support with CancellationToken.	3.7K
ktsu.FileSystemProviders.Native A comprehensive .NET library providing high-performance interfaces and ready-to-use implementations for common cross-cutting concerns including compression (Gzip, Brotli, Deflate, ZLib), encoding (Base64, Hex), encryption (AES), hashing (15 algorithms including SHA, MD5, CRC, FNV, XxHash), serialization (JSON, YAML, TOML), caching, persistence, validation, logging, navigation, command execution, and filesystem access. Features zero-allocation Span-based operations, default interface implementations to minimize boilerplate, and comprehensive async support with CancellationToken.	3.6K
ktsu.HashProviders.SHA1 A comprehensive .NET library providing high-performance interfaces and ready-to-use implementations for common cross-cutting concerns including compression (Gzip, Brotli, Deflate, ZLib), encoding (Base64, Hex), encryption (AES), hashing (15 algorithms including SHA, MD5, CRC, FNV, XxHash), serialization (JSON, YAML, TOML), caching, persistence, validation, logging, navigation, command execution, and filesystem access. Features zero-allocation Span-based operations, default interface implementations to minimize boilerplate, and comprehensive async support with CancellationToken.	3.6K
ktsu.HashProviders.SHA256 A comprehensive .NET library providing high-performance interfaces and ready-to-use implementations for common cross-cutting concerns including compression (Gzip, Brotli, Deflate, ZLib), encoding (Base64, Hex), encryption (AES), hashing (15 algorithms including SHA, MD5, CRC, FNV, XxHash), serialization (JSON, YAML, TOML), caching, persistence, validation, logging, navigation, command execution, and filesystem access. Features zero-allocation Span-based operations, default interface implementations to minimize boilerplate, and comprehensive async support with CancellationToken.	3.6K

GitHub repositories

This package is not used by any popular GitHub repositories.

Version	Downloads	Last Updated
2.0.0	236	8/14/2026
1.2.2	778	8/11/2026
1.2.1	1,481	7/1/2026
1.2.0	1,516	7/1/2026
1.1.3	1,613	6/30/2026
1.1.2	116	6/28/2026
1.1.0	146	2/19/2026

## v2.0.0 (major)

Changes since v1.2.2:

- feat!: report bytes written from span APIs, fix storage format, stop leaking Polyfill [major] ([@matt-edmondson](https://github.com/matt-edmondson))
- fix: repair data-corrupting string overloads, make AES thread-safe, ship DI extensions [major] ([@matt-edmondson](https://github.com/matt-edmondson))

## v1.2.2 (patch)

Changes since v1.2.1:

- chore: update ktsu.Sdk to 2.21.1 [patch] ([@matt-edmondson](https://github.com/matt-edmondson))

## v1.2.1 (patch)

Changes since v1.2.0:

- [patch] fix(packaging): re-enable package validation on ktsu.Sdk 2.13.2 ([@matt-edmondson](https://github.com/matt-edmondson))

## v1.2.0 (minor)

Changes since v1.1.0:

- Merge origin/main into consolidate-into-essentials ([@matt-edmondson](https://github.com/matt-edmondson))
- docs: document obfuscation, NewtonsoftJson, All meta-package, and new naming convention ([@matt-edmondson](https://github.com/matt-edmondson))
- feat: add ktsu.Essentials.All meta-package ([@matt-edmondson](https://github.com/matt-edmondson))
- feat: port NewtonsoftJson serialization provider from Common ([@matt-edmondson](https://github.com/matt-edmondson))
- refactor: conform all providers to SDK naming convention ([@matt-edmondson](https://github.com/matt-edmondson))
- refactor: conform serialization providers to SDK naming convention ([@matt-edmondson](https://github.com/matt-edmondson))
- feat: add Composite obfuscation provider that pipelines a chain ([@matt-edmondson](https://github.com/matt-edmondson))
- [patch] fix(core): disable strict ApiCompat package validation ([@matt-edmondson](https://github.com/matt-edmondson))
- feat: add Hex obfuscation provider composing the Hex encoder ([@matt-edmondson](https://github.com/matt-edmondson))
- [patch] fix(providers): derive package ids and disable strict ApiCompat ([@matt-edmondson](https://github.com/matt-edmondson))
- fix: keep Base64 obfuscator encoder ctor public; register via factory to avoid DI greedy-ctor ([@matt-edmondson](https://github.com/matt-edmondson))
- feat: add Base64 obfuscation provider composing the Base64 encoder ([@matt-edmondson](https://github.com/matt-edmondson))
- feat: add BitRotate obfuscation provider ([@matt-edmondson](https://github.com/matt-edmondson))
- feat: add Reverse obfuscation provider ([@matt-edmondson](https://github.com/matt-edmondson))
- test: scope obfuscation string round-trip out of the shared byte-transform harness ([@matt-edmondson](https://github.com/matt-edmondson))
- feat: add Caesar obfuscation provider ([@matt-edmondson](https://github.com/matt-edmondson))
- feat: add Xor obfuscation provider and obfuscation test harness ([@matt-edmondson](https://github.com/matt-edmondson))
- feat: add IObfuscationProvider interface to Essentials core ([@matt-edmondson](https://github.com/matt-edmondson))
- docs: implementation plan for Essentials consolidation (Phase 1) ([@matt-edmondson](https://github.com/matt-edmondson))
- docs: design spec for consolidating Abstractions + Common into Essentials ([@matt-edmondson](https://github.com/matt-edmondson))
- [patch] Pin Testably.Abstractions.FileSystem.Interface to stable 10.0.0 ([@matt-edmondson](https://github.com/matt-edmondson))
- chore: remove unused SourceLink package versions ([@matt-edmondson](https://github.com/matt-edmondson))
- chore: simplify package references and drop redundant SourceLink deps ([@matt-edmondson](https://github.com/matt-edmondson))
- Remove stale files ([@matt-edmondson](https://github.com/matt-edmondson))

## v1.1.3 (patch)

Changes since v1.1.2:

- [patch] fix(core): disable strict ApiCompat package validation ([@matt-edmondson](https://github.com/matt-edmondson))
- [patch] fix(providers): derive package ids and disable strict ApiCompat ([@matt-edmondson](https://github.com/matt-edmondson))

## v1.1.2 (patch)

Changes since v1.1.1:

- [patch] Pin Testably.Abstractions.FileSystem.Interface to stable 10.0.0 ([@matt-edmondson](https://github.com/matt-edmondson))

## v1.1.1 (patch)

Changes since v1.1.0:

- chore: remove unused SourceLink package versions ([@matt-edmondson](https://github.com/matt-edmondson))
- chore: simplify package references and drop redundant SourceLink deps ([@matt-edmondson](https://github.com/matt-edmondson))
- Remove stale files ([@matt-edmondson](https://github.com/matt-edmondson))

## v1.1.0 (major)

- Update documentation to reflect changes in hash provider implementations ([@matt-edmondson](https://github.com/matt-edmondson))
- Rename to Essentials ([@matt-edmondson](https://github.com/matt-edmondson))
- Add persistence providers: AppData, FileSystem, and Temp ([@matt-edmondson](https://github.com/matt-edmondson))
- Consolidate shared functionality ([@matt-edmondson](https://github.com/matt-edmondson))
- Rename tests project and convert to slnx ([@matt-edmondson](https://github.com/matt-edmondson))
- Merge remote-tracking branch 'common/main' into merge-common-providers ([@matt-edmondson](https://github.com/matt-edmondson))
- Add configuration providers for JSON, TOML, and YAML formats ([@matt-edmondson](https://github.com/matt-edmondson))
- Add abstractions for command execution, configuration, encoding, logging, navigation, persistence, and validation ([@matt-edmondson](https://github.com/matt-edmondson))
- Add .gitignore and project.yml for Serena configuration ([@matt-edmondson](https://github.com/matt-edmondson))
- Refactor permissions in dotnet.yml for least privilege; add SonarLint settings.json for project configuration ([@matt-edmondson](https://github.com/matt-edmondson))
- Remove legacy build scripts ([@matt-edmondson](https://github.com/matt-edmondson))
- Remove skipped_release logic from build steps in dotnet.yml ([@matt-edmondson](https://github.com/matt-edmondson))
- api suppressions ([@matt-edmondson](https://github.com/matt-edmondson))
- Update KtsuBuild cloning method to retrieve the latest tag correctly ([@matt-edmondson](https://github.com/matt-edmondson))
- Update KtsuBuild cloning method to use latest tag ([@matt-edmondson](https://github.com/matt-edmondson))
- Add compression, hashing, and obfuscation providers ([@matt-edmondson](https://github.com/matt-edmondson))
- Migrate to KtsuBuild dotnet build pipeline ([@matt-edmondson](https://github.com/matt-edmondson))
- Add .gitignore and project.yml for Serena configuration ([@matt-edmondson](https://github.com/matt-edmondson))
- Refactor null checks in IObfuscationProvider and ISerializationProvider to use Ensure.NotNull method; update Polyfill package version to 9.8.0 ([@matt-edmondson](https://github.com/matt-edmondson))
- Update docs and api compatibility files ([@matt-edmondson](https://github.com/matt-edmondson))
- Add project references and update AssemblyInfo for testing and source linking ([@matt-edmondson](https://github.com/matt-edmondson))
- Change project SDK from Microsoft.NET.Sdk to MSTest.Sdk ([@matt-edmondson](https://github.com/matt-edmondson))
- Update target framework to net10.0 and adjust assertions in tests ([@matt-edmondson](https://github.com/matt-edmondson))
- Update package versions in Directory.Packages.props ([@matt-edmondson](https://github.com/matt-edmondson))
- Add CLAUDE.md for project guidance and documentation ([@matt-edmondson](https://github.com/matt-edmondson))
- Add test project detection to Invoke-DotNetTest function ([@matt-edmondson](https://github.com/matt-edmondson))
- Update .NET version to 10.0 and adjust test coverage reporting ([@matt-edmondson](https://github.com/matt-edmondson))
- Update project configuration and add CLAUDE.md for documentation ([@matt-edmondson](https://github.com/matt-edmondson))
- Enhance project type detection in update-winget-manifests.ps1 by adding checks for generated NuGet packages and refining logic to distinguish between library, executable, test, and demo projects. ([@matt-edmondson](https://github.com/matt-edmondson))
- Refactor ISerializationOptions interface to unify member serialization policies and enhance clarity. Introduce new properties for serialization and deserialization policies, and update related enums for improved configurability. ([@matt-edmondson](https://github.com/matt-edmondson))
- Add ISerializationOptions interface and related policies for serialization configuration ([@matt-edmondson](https://github.com/matt-edmondson))
- Add SHA384 and SHA512 hash providers, along with FNV1_32, FNV1a_32, FNV1_64, and FNV1a_64 implementations. Update Common.sln and add corresponding unit tests for all new providers. Enhance existing tests for dependency injection and serialization. Include necessary project files and suppressions for compatibility. ([@matt-edmondson](https://github.com/matt-edmondson))
- Remove .runsettings file, update project references in Common.sln, and add new providers for Gzip, Aes, Base64, MD5, SHA1, and SHA256 with corresponding project files. Update package versions in Directory.Packages.props and global.json. Add unit tests for dependency injection and functionality verification. ([@matt-edmondson](https://github.com/matt-edmondson))
- Update global.json and Abstractions.csproj to use ktsu.Sdk version 1.60.0 and switch project SDK to Microsoft.NET.Sdk, improving compatibility with .NET 8.0. ([@matt-edmondson](https://github.com/matt-edmondson))
- Add MD5HashProvider implementation and project files ([@matt-edmondson](https://github.com/matt-edmondson))
- Initial commit ([@matt-edmondson](https://github.com/matt-edmondson))
- Refactor ISerializationProvider interface to use generic type parameters for deserialization methods, enhancing type safety and usability. Update CompatibilitySuppressions.xml to remove obsolete suppressions related to nullable attributes, ensuring compatibility with .NET 8.0. ([@matt-edmondson](https://github.com/matt-edmondson))
- Update CompatibilitySuppressions.xml to reflect changes in diagnostic IDs and target methods for the ktsu.Abstractions library, enhancing compatibility with .NET 8.0. This includes updates for compression, encryption, hashing, and obfuscation methods, ensuring accurate suppression of diagnostics across versions. ([@matt-edmondson](https://github.com/matt-edmondson))
- Enhance ktsu.Abstractions library by refining interface descriptions and adding zero-allocation Try methods for compression, encryption, hashing, obfuscation, and serialization. Update README to reflect these changes, emphasizing performance improvements and usage examples. ([@matt-edmondson](https://github.com/matt-edmondson))
- Update README to reflect changes in target frameworks and provide an example implementation of a custom MD5 hash provider, enhancing clarity on usage and functionality. ([@matt-edmondson](https://github.com/matt-edmondson))
- Refactor interfaces in ktsu.Abstractions to use Try methods for compression, encryption, hashing, obfuscation, and serialization, enhancing performance by reducing allocations. Update README to reflect these changes and clarify usage. ([@matt-edmondson](https://github.com/matt-edmondson))
- Add System.Memory package reference and enhance interfaces in ktsu.Abstractions for better async support. Update README for clarity on usage and installation. ([@matt-edmondson](https://github.com/matt-edmondson))
- Remove EnumOrderingAnalyzer project and related files from the solution, streamlining the project structure and eliminating unused analyzers. ([@matt-edmondson](https://github.com/matt-edmondson))
- Remove obsolete abstraction models for compression, encryption, hashing, obfuscation, and filesystem types, along with global usings. This cleanup streamlines the project structure. ([@matt-edmondson](https://github.com/matt-edmondson))
- Add detailed README for ktsu.Abstractions library, outlining interfaces for compression, encryption, hashing, obfuscation, serialization, and filesystem access. Include installation instructions, quickstart examples, and contributing guidelines. ([@matt-edmondson](https://github.com/matt-edmondson))
- Remove outdated files and update project references to reflect the new repository name 'Abstractions'. Set version to 1.0.0 and clean up changelog, README, and tags. ([@matt-edmondson](https://github.com/matt-edmondson))
- Initial commit ([@matt-edmondson](https://github.com/matt-edmondson))

ktsu.Essentials 2.0.0

ktsu.Essentials

Introduction

Features

Installation

Package Manager Console

.NET CLI

Package Reference

Usage Examples

Basic Example

Compression

Serialization

Caching

Persistence

Implementing a Custom Provider

API Reference

ICompressionProvider

IEncodingProvider

IEncryptionProvider

IHashProvider

ISerializationProvider

ICacheProvider<TKey, TValue>

IPersistenceProvider<TKey>

IValidationProvider<T>

ILoggingProvider

INavigationProvider<T>

ICommandExecutor

IFileSystemProvider